Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 2.34 KB
Raw

Contributing

We welcome your contributions!

There are many ways you can contribute to this project. Since this project is in its adolescenct stage, the simplest way to contribute is to start using pbd. (Please adhere to our adoption rules.)

Adopter

You are welcome to download the product(s) and its source code for your use. By doing so, you are agreeing to the following responsibilities:

  • Adhere to the License
  • Report any bugs, enhancement requests, or product suggestions using our Issues Tracking
  • Submit any questions or comments for discussion about the this crate in the Rust User Forum

Developer

If you would like to get more involved and contribute to the code, (e.g.: fixing an issue or providing an enhancement), you are welcome to follow these steps:

NOTE: In an effort to ensure compatibility, this project is restricted to the STABLE RELEASE

  1. File a request, (or select an existing one), and tag me with @dsietz on an issue. I'll then get you setup as a contributor.
  2. Fork our repository
  3. Make the necessary code changes in your repo
  4. Ensure that our testing strategy and standards are adhered as part of your development
  5. Ensure that you have updated the What's New section of the README file to include your changes
  6. Submit a properly formatted pull request to merge your changes to our development branch

As a note, all contributions are expected to follow the Rust Code of Conduct.

Project

This project attempts to be an idiomatic rust library and to maintain a sane structure. All source code is located in src/, and tests are in tests/.

The source is split into four modules:

  • lib.rs contains top-level traits, module documentation, and helper functions
  • builders.rs contains all the configuration code
  • errors.rs contains error handling for finishing configuration