Skip to content

Latest commit

 

History

History
122 lines (83 loc) · 5.98 KB

Contributing.md

File metadata and controls

122 lines (83 loc) · 5.98 KB
Raw

Contributing to Rusix

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Rusix. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

How Can I Contribute?

Contributor License Agreement

How Can I Contribute?

System Requirements

rusix is targeted at the modern linux platform. Various dependencies, primarily libudev, require this. If you want to contribute to code/test rusix, you will need a modern linux system with the following packages installed:

sudo yum install libudev-devel openssl-devel zeromq-devel capnproto-devel
capnproto

before you try to build or test any software.

If you spot any other missing packages, please let us know by filing an issue.

Quick Questions

There is an irc channel: irc.mozilla.org: #rusix

Reporting Bugs

This section guides you through submitting a bug report for Rusix. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. After you've determined what your bug is related to, create an issue on that repository and provide the following information.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Rusix, e.g. which command exactly you used in the terminal, or how you started Rusix otherwise. When listing steps, don't just say what you did, but explain how you did it.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.

Provide more context by answering these questions:

  • Did the problem start happening recently (e.g. after updating to a new version of Rusix) or was this always a problem?
  • If the problem started happening recently, can you reproduce the problem in an older version of Rusix? What's the most recent version in which the problem doesn't happen? You can download older versions of Rusix from the releases page.
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • Which version of Rusix are you using?.
  • What's the name and version of the OS you're using?

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Rusix, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue in this repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Specify the name and version of the OS you're using.

Your First Code Contribution

Unsure where to begin contributing to Rusix? You can start by looking through these beginner and help-wanted issues:

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

Please ensure that every new source file starts with the un-modified contents of prototypes/license.rs.

Local development

Rusix enhancements can be developed locally. For instructions on how to do this, see the following sections in the Development Guide:

Pull Requests

  • Please run rustfmt over your code before submitting. It is very helpful. If it changes a substantial amount of code please consider submitting a separate rustfmt pull request.
  • Try to document complex functions when possible.