Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 2.31 KB
Raw

Contributing

This project welcomes contributions and suggestions. By contributing, you confirm that you have the right to, and actually do, grant us the rights to use your contribution. More information below.

Please feel free to contribute code, ideas, improvements, and patches - we've added some general guidelines and information below, and you can propose changes to this document in a pull request.

This project has adopted the Contributor Covenant Code of Conduct.

Rights to your contributions

By contributing to this project, you:

  • Agree that you have authored 100% of the content
  • Agree that you have the necessary rights to the content
  • Agree that you have received the necessary permissions from your employer to make the contributions (if applicable)
  • Agree that the content you contribute may be provided under the Project license(s)
  • Agree that, if you did not author 100% of the content, the appropriate licenses and copyrights have been added along with any other necessary attribution.

Code of Conduct

This project, and people participating in it, are governed by our code of conduct. By taking part, we expect you to try your best to uphold this code of conduct. If you have concerns about unacceptable behavior, please contact the community leaders responsible for enforcement at [email protected].

What should I know before I get started?

Workflow

  • We use the standard GitHub workflow.

  • Changes are first be merged into the dev branch pushed to main after a period of review by the GSF members. The main branch is considered the official version of a project by the GSF.

  • Discuss the change you want to make with the project team either through email or issues tab or the preferred communication method of this team.

  • Open a pull request against the dev branch with your proposed changes.

  • The team will discuss your changes, add feedback or accept them and merge your pull request into the dev branch.

  • At key moments or milestones of the projects the dev branch will be merged into the main branch.

Documentation

Please document changes as you go in the the documentation directory.