Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 4.65 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 4.65 KB
Raw

Contributing to the BuildSafe software

The BuildSafe software is managed by BuildSafe, and we eagerly welcome contributions from the community. There are many ways to get involved!

Provide Feedback

You may find things that can be improved as you use BuildSafe (bsf). You can help by reporting Github issues when:

  • BuildSafe/bsf crashes, or you encounter a bug that can only be resolved by re-installing or restarting bsf
  • A new feature or an enhancement to an existing feature will improve the utility or usability of bsf

Before creating a new issue, please confirm that an existing issue doesn't already exist.

Participate in the Community

You can engage with the BuildSafe community by:

  • Helping other users on Discord
  • Improving documentation
  • Participating in general discussions about technology and Supply Chain Security.

Contributing Code

You can contribute to the BuildSafe software by:

  • Enhancing current functionality
  • Fixing bugs
  • Adding new features and capabilities

If you are looking to make a substantial, complex, or wide-sweeping contribution, please engage with us on Discord before you begin so we can collaborate with you.

Steps to Contribute Code

Follow the following steps to ensure your contribution goes smoothly.

  1. Read and follow the steps outlined in the BuildSafe Contributing Policy.
  2. Fork the GitHub Repository allowing you to make the changes in your own copy of the repository.
  3. Create a GitHub issue if one doesn't exist already.
  4. Make the changes you would like to include, adding new tests where possible, and make sure all relevant existing tests are passing.
  5. Ensure that you are in the CONTRIBUTORS file (see the Adding Yourself to the Contributors List section for instructions)
  6. Create a pull request on GitHub. If you're new to GitHub, read about pull requests. You are welcome to submit your pull request for commentary or review before it is complete by creating a draft pull request. Please include specific questions or items you'd like feedback on.
  7. A member of the BuildSafe team will review your PR and either merge, comment, and/or assign someone for review.
  8. Work with the reviewer to complete a code review. For each change, create a new commit and push it to make changes to your pull request. When necessary, the reviewer can trigger CI to run tests prior to merging.
  9. Once you believe your pull request is ready to be reviewed, ensure the pull request is no longer a draft by marking it ready for review.
  10. The reviewer will look over your contribution and either approve it or provide comments letting you know if there is anything left to do. We try to give you the opportunity to make the required changes yourself, but in some cases, we may perform the changes ourselves if it makes sense to (minor changes or for urgent issues). We do our best to review PRs promptly, but complex changes could require more time.
  11. After completing your review, a BuildSafe team member will trigger merge to run all tests. Upon passing, your change will be merged into main, and your pull requests will be closed. All merges to main create a new release, and all final changes are attributed to you.

Note: In some cases, we might decide that a PR should be closed without merging. We'll make sure to provide clear reasoning when this happens.

Adding Yourself to the Contributors List

When making a pull request to the BuildSafe software, you must add yourself to the CONTRIBUTORS list. You will only have to do this the first time that you contribute to the software. For this, we recommend adding yourself with a separate commit (does not have to be a separate PR) to the file.

What Does this Mean for You?

Here is what being a contributor means for you:

  • License all our contributions to the project under the Apache License, Version 2.0
  • Have the legal rights to license our contributions ourselves, or get permission to license them from our employers, clients, or others who may have them

For more information, see the README and feel free to reach out to us on Discord.