generated from ossf/project-template
-
Notifications
You must be signed in to change notification settings - Fork 185
Add CONTRIBUTING.md guide #1002
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
GeauxJD
wants to merge
4
commits into
ossf:main
Choose a base branch
from
GeauxJD:add-contributing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.