|
| 1 | +# Contributing to the OpenSSF Best Practices for Open Source Developers Working Group |
| 2 | + |
| 3 | +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. |
| 4 | + |
| 5 | +## How to Connect with Us |
| 6 | + |
| 7 | +- **Public Calendar:** Stay informed about our meetings, events, and activities by checking our [public calendar](https://openssf.org/calendar/). |
| 8 | + |
| 9 | +- **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. |
| 10 | + |
| 11 | +## How to Contribute |
| 12 | + |
| 13 | +We value all contributions, from improving documentation to participating in discussions and developing new initiatives. Here’s how you can get started: |
| 14 | + |
| 15 | +### 1. Participate in Discussions |
| 16 | + |
| 17 | +- Join our #wg-best-practices-ossdev channel via the [OpenSSF Slack channel](https://openssf.slack.com/archives/C01AHCRP8BT). |
| 18 | + |
| 19 | +- Attend working group meetings listed on the public calendar. |
| 20 | + |
| 21 | +### 2. Report Issues or Suggest Enhancements |
| 22 | + |
| 23 | +- Use the [GitHub Issues](https://github.com/ossf/wg-best-practices-os-developers/issues) tab to report problems or suggest ideas. |
| 24 | +- Follow our issue template to provide clear and detailed information. |
| 25 | + |
| 26 | +### 3. Submit Pull Requests |
| 27 | + |
| 28 | +- Fork the repository. |
| 29 | +- Create a feature branch (`git checkout -b feature/your-feature-name`). |
| 30 | +- Commit changes (`git commit -m 'Add your message here'`). |
| 31 | +- See here for more information on [signing your commit](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). |
| 32 | +- Push your branch (`git push origin feature/your-feature-name`). |
| 33 | +- Open a Pull Request (PR) with a detailed description. |
| 34 | + |
| 35 | +### 4. Review Process |
| 36 | + |
| 37 | +- All PRs are reviewed by maintainers. |
| 38 | +- Ensure your PR is well-documented and follows project guidelines. |
| 39 | +- Be open to feedback and ready to make improvements. |
| 40 | +- Don't hesitate to post a reminder if you didn't get any feedback after some time, e.g. two weeks. |
| 41 | + |
| 42 | +## Code of Conduct |
| 43 | + |
| 44 | +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. |
| 45 | + |
| 46 | +## Community Expectations |
| 47 | + |
| 48 | +- **Be Respectful:** Value each other's ideas and contributions. |
| 49 | +- **Be Collaborative:** Work together to solve problems and build new initiatives. |
| 50 | +- **Be Open:** Share your knowledge and be open to learning from others. |
| 51 | + |
| 52 | +We’re excited to collaborate with you and appreciate your support in advancing open source cybersecurity! |
| 53 | + |
| 54 | +For any questions or additional guidance, contact us through Slack or during our working group meetings. |
0 commit comments