Skip to content

Latest commit

 

History

History
171 lines (129 loc) · 7.26 KB

CONTRIBUTING.md

File metadata and controls

171 lines (129 loc) · 7.26 KB
Raw

Contributor Roles and Responsibilities1

Want to contribute? Great! First, read this document, which is a set of guidelines to help you contribute to this project.

Whether you’re finding bugs, adding new capabilities, fixing anything broken, or improving documentation, get started by submitting an issue or pull request.

This project uses the following tools to organize discussion.

  • Issue tracker: For discussing issues related to the project.
  • Pull requests: For discussing and reviewing changes that are in progress.
  • Synchronous chat channel: For casual conversation, collaboration, quick exchanges, and questions.

Issue Tracker

If you’ve found a bug, would like to request a new feature or make a proposal, file a GitHub issue!

Resolving Open Issues

We track ongoing endeavors via the GitHub issues associated with each repository, and that’s where you can find tasks to undertake. First, check the labels on the issue you’re interested in.

Once you have identified an issue you would like to work on, follow these steps:

  1. Comment on it and say you would like to work on that issue.
  2. Wait for someone to confirm that you may work on the issue before writing any code. The person who confirms will add a wip Issues and PRs that are still a work in progress label to the issue to indicate that the issue has been assigned.
  3. Once the issue has been labeled as a work in progress, write your code and submit your PR.
  4. Wait for code review and address any issues raised as soon as you can.

Even if you are not done with the issue, create a draft pull request and push your code early and often. If we haven’t heard from you in over a week and someone else expresses interest in that issue, we may approve the new person’s work.

Opening a New Issue

If you want to work on something that there is no GitHub issue for, then propose the change by opening a new GitHub issue associated with the respective repository and propose your change there. Be sure to include implementation details and the rationale for the proposed change.

Pull Requests

If you’d like to propose and collaborate on changes, open a pull request!

Here are a few things you can do that will increase the likelihood of having your pull request merged:

  • Follow standards for style and code quality.
  • Write tests when applicable.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Contributions to this project are released to the public under the project’s open-source license(s). The license(s) for a project may be located within the [LICENSE][] folder in the root directory of the repository.

Project Documentation

The README.md in the root of the repository should contain or link to project documentation. If you cannot find the documentation you’re looking for, please file a GitHub issue with details of what you’d like to see documented.

Questions or Thoughts?

Support requests (e.g., asking questions) or feedback (e.g., constructive criticism) may be directed to the @OpenINF support account on Twitter.

Additional Resources

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please see the CODE_OF_CONDUCT.md file for expected behavior.

Developer’s Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Reporting Security Issues

Please see the SECURITY.md file.

Attribution

Developer Certificate of Origin Legal Text

Footnotes

  1. https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/setting-guidelines-for-repository-contributors ↩