Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 3.47 KB

CONTRIBUTING.MD

File metadata and controls

78 lines (53 loc) · 3.47 KB

Contributing Guide for CloudState

Welcome to the CloudState contributing guide! CloudState is an open-source tool designed to empower developers, system administrators, and cloud architects by providing a detailed, real-time snapshot of all resources deployed across cloud environments. If you're interested in contributing to CloudState, here's how you can help.

Prerequisites

Before you start contributing, ensure you have the following prerequisites installed:

  • Go 1.18 or higher

Setting Up Your Development Environment

  1. Fork the Repository: Start by forking the CloudState repository on GitHub.
  2. Clone Your Fork: Clone your fork to your local machine: 
    git clone https://github.com/YOUR_USERNAME/cloudstate.git
  3. Navigate to the Project Directory: 
    cd cloudstate
  4. Build the Project: 
    go build cmd/main.go

Making Contributions

Here are the areas where you can contribute:

  1. Code: Implement new features or fix bugs.
  2. Documentation: Improve installation instructions, usage guides, and best practices.
  3. Testing: Write tests to ensure the code is reliable and covers edge cases.
  4. Issues: Report bugs or suggest new features by creating issues in the repository.

Contribution Workflow

  1. Create a Branch: Create a new branch for your work. 
    git checkout -b your-branch-name
  2. Make Changes: Implement your changes or improvements.
  3. Commit Your Changes: Make sure your commit messages are clear and follow best practices.
  4. Push to Your Fork: Push your changes to your fork on GitHub. 
    git push origin your-branch-name
  5. Submit a Pull Request: Go to the original CloudState repository and submit a pull request from your branch.

Code Review Process

After you submit a pull request, the project maintainers will review your changes. They may suggest improvements or request additional changes before merging your contribution. Engage in the review process to ensure your contribution meets the project's standards.

Community and Communication

If you have questions or need help, you can reach out to the community through the project's communication channels. This could be a project mailing list, chat channel, or forums.

Recognition and Credit

Contributors are the lifeblood of open source projects. CloudState recognizes all contributions, whether code, documentation, or community support. Your efforts will be acknowledged in the project's documentation or release notes.

Code of Conduct

CloudState is committed to fostering an inclusive and welcoming environment. All contributors are expected to adhere to the project's code of conduct, which outlines expectations for participation and steps for reporting unacceptable behavior.

License

By contributing to CloudState, you agree that your contributions will be licensed under the same MIT License that covers the project[1].

Conclusion

Contributing to CloudState is a valuable way to improve the software you rely on while also enhancing your skills and contributing to the community. We appreciate your interest in contributing and look forward to your valuable input!

Remember, this guide is just a starting point. For more detailed information on contributing to Go projects, you can refer to the Go project's contribution guide[2] and other resources provided in this document.

Citations: [1] https://github.com/Cloud-Code-AI/cloudstate [2] https://go.dev/doc/contribute