Skip to content

Latest commit

 

History

History
84 lines (51 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

84 lines (51 loc) · 4.05 KB
Raw

Contributing to OSC-documentation

Thank you for considering helping out! We're glad you're reading this because we need volunteer developers to help this project come to fruition. Looking to update information or feature your project? Feel free to make the change yourself. First, please read the code of conduct. We take it very seriously! Next, if you want to help out, do the following: Fork the project. Make a feature branch with the name of your change. Make a change. Commit your code. Issue a Pull Request. Once your PR is issued, we will review your work and decide to add it to the project! For more details about contributing to GitHub projects, see How to use Github: Fork, Branch, Track, Squash, and Pull Request.

Types of contribution

Provide information on what kinds of contributions your project is looking for here. For example, these can be bug reports, help answering user questions, improving documentation, bug fixes, and new feature implementations.

Openness

The configuration of an open project enables frictionless contributing. Projects should be discoverable and well-documented. Anyone within our Intersect MBO should be able to find a desired project and ramp up without direct guidance from host team members.

Code of Conduct

The Code of Conduct governs this project and everyone participating. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Reporting Bugs

If you are subject to or witness unacceptable behavior or have any other concerns, please notify a community organizer as soon as possible.

Feature requests

Add information on how to submit feature requests here. Also, include information on what contributors can expect regarding time first to respond and process after that.

Contributing documentation

Include information on any documentation best practices your project follows, how to build documentation, checks to run, and how to submit the changes made back to the project.

Transparency

For guest teams to be able to contribute meaningfully to a project, the host team must be transparent. This means that guest teams should be able to have an understanding of:

  • The project/repo and its direction
  • Outstanding feature requirements
  • Progress on feature requirements
  • Decision-making of the host team

Prioritized Mentorship

Mentorship from the host team to the guest team via maintainers is crucial to Intersect MBO. Contributors on guest teams are up-leveled so that they understand enough about the host team’s project/repo to change it successfully.

Voluntary Code Contribution

When contributing to this project, you must agree that you have authored 100% of the content, have the necessary rights to the content, and that the content you contribute may be provided under the project license.

Your First Code Contribution

Need help determining where to begin contributing to osc-documentation? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues that should only require a few lines of code and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Styleguides

Your work will be much appreciated if you follow these style guides in your contributions.

Git Commit Messages

  • Use the present tense ("Add feature," not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

[Programming Language One] Styleguide

Documentation Styleguide

Use Markdown for documentation. Following best practices.

License

By contributing, you agree that your contributions will be licensed under its Apache 2.0 License.