We're thrilled that you're interested in contributing to GoatStyles! This project is a repository for professional code style guides used by GoatBytes.IO and the wider software development community. Our aim is to uphold the highest standards of software engineering practices, making the development process more efficient and secure.
GoatStyles is actively used by GoatBytes.IO internally to ensure consistency, quality, and security across our projects. The style guides within this repository reflect our current best practices and are subject to updates as our standards evolve.
We welcome contributions from the community! Whether you're fixing a typo, proposing a new section, or suggesting changes to an existing guide, your input is valuable. Here's how you can contribute:
Due to the diversity in coding standards across different organizations, we recommend creating a fork of the GoatStyles repository for any significant modifications or additions. This approach allows you to customize the style guides to better fit your organizational needs while contributing valuable insights back to the main project.
-
Individual Contributor License Agreement (CLA): Before we can accept your contributions, you must complete our Individual Contributor License Agreement (CLA). This legal document ensures that your contributions can be included in the project without licensing issues.
-
Make Your Changes: Once the CLA is signed, make your proposed changes in your forked repository. Please ensure that your changes adhere to the existing format and standards of the style guides.
-
Submit a Pull Request: After you've made your changes, submit a PR to the main GoatStyles repository. Include a clear description of your changes and any additional context that might help in the review process.
All PRs will undergo a review process by the GoatStyles team. While we value every contribution, PRs may be closed if they do not align with our internal standards or current needs. However, suggestions for improvement are always welcome, and we encourage contributors to engage in discussions about their proposals.
Even if your PR does not get merged, your contributions play a crucial role in the continuous improvement of GoatStyles. We encourage you to maintain your fork and share your customizations with the community. Your insights and enhancements can greatly benefit others and lead to valuable discussions and ideas for future updates.
If you have any questions or suggestions about contributing to GoatStyles, please feel free to open an issue in the repository. We're always looking for ways to improve the project and appreciate your feedback.
Thank you for contributing to GoatStyles and helping us enhance the standards of software engineering practices!