Skip to content

Latest commit

 

History

History
95 lines (70 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

95 lines (70 loc) · 3.34 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project! Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from the open source community.

Please read through this document before submitting an issue or pull request to ensure we have all the necessary information to effectively respond to your bug report or contribution.

An old-school developer's mailing list is available. See lists.linux.dev for links to subscribe to [email protected] or to access archived threads.

Opening issues

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open or recently closed issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The version of our code being used
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment

If you think you've found a security vulnerability, do not raise a GitHub issue and follow the instructions in our security policy.

Contributing code

We welcome your code contributions. Before submitting code via a pull request, you will need to have signed the Oracle Contributor Agreement (OCA) and your commits need to include the following line using the name and e-mail address you used to sign the OCA:

Signed-off-by: Your Name <[email protected]>

This can be automatically added to pull requests by committing with --sign-off or -s, e.g.

git commit --signoff

Only pull requests from committers that can be verified as having signed the OCA can be accepted.

Pull request process

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. You open an issue to discuss any significant work - we would hate for your time to be wasted.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.

To send us a pull request, please:

  1. Fork the repository.
  2. Modify the source. Focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to review on your change.
  3. Ensure local tests pass.
  4. Commit to your fork using concise commit messages.
  5. Send us a pull request, answering any default questions in the pull request interface.
  6. Pay attention to any automated CI failures reported in the pull request and stay involved in the conversation.

GitHub provides additional document on forking a repository and creating a pull request.

Licensing

See the COPYING file for our project's licensing. We will ask you to confirm the licensing of your contribution.

Code of conduct

Follow the Golden Rule. If you'd like more specific guidelines, see the Contributor Covenant Code of Conduct.