diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..2cf0ba43 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,54 @@ +# Contributing to the OpenSSF Best Practices for Open Source Developers Working Group + +Welcome! We're excited that you're interested in contributing to the Best Practices for Open Source Developers Working Group. We aim to create a supportive, inclusive environment where everyone can thrive and make meaningful contributions. + +## How to Connect with Us + +- **Public Calendar:** Stay informed about our meetings, events, and activities by checking our [public calendar](https://openssf.org/calendar/). + +- **Slack Channel:** Join the conversation on our #wg-best-practices-ossdev [OpenSSF Slack channel](https://openssf.slack.com/archives/C01AHCRP8BT). This is the best place to ask questions, share ideas, and collaborate. + +## How to Contribute + +We value all contributions, from improving documentation to participating in discussions and developing new initiatives. Here’s how you can get started: + +### 1. Participate in Discussions + +- Join our #wg-best-practices-ossdev channel via the [OpenSSF Slack channel](https://openssf.slack.com/archives/C01AHCRP8BT). + +- Attend working group meetings listed on the public calendar. + +### 2. Report Issues or Suggest Enhancements + +- Use the [GitHub Issues](https://github.com/ossf/wg-best-practices-os-developers/issues) tab to report problems or suggest ideas. +- Follow our issue template to provide clear and detailed information. + +### 3. Submit Pull Requests + +- Fork the repository. +- Create a feature branch (`git checkout -b feature/your-feature-name`). +- Commit changes (`git commit -m 'Add your message here'`). +- See here for more information on [signing your commit](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). +- Push your branch (`git push origin feature/your-feature-name`). +- Open a Pull Request (PR) with a detailed description. + +### 4. Review Process + +- All PRs are reviewed by maintainers. +- Ensure your PR is well-documented and follows project guidelines. +- Be open to feedback and ready to make improvements. +- Don't hesitate to post a reminder if you didn't get any feedback after some time, e.g. two weeks. + +## Code of Conduct + +We are committed to maintaining a welcoming, inclusive, and respectful environment. Please read and follow our [Code of Conduct](https://github.com/ossf/wg-best-practices-os-developers/blob/main/code-of-conduct.md) to ensure a positive experience for everyone. + +## Community Expectations + +- **Be Respectful:** Value each other's ideas and contributions. +- **Be Collaborative:** Work together to solve problems and build new initiatives. +- **Be Open:** Share your knowledge and be open to learning from others. + +We’re excited to collaborate with you and appreciate your support in advancing open source cybersecurity! + +For any questions or additional guidance, contact us through Slack or during our working group meetings.