Thanks for considering contributing to dcbfs!
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
dcbfs is an open source project and we love to receive contributions from our community. There are many ways to contribute: writing tutorials, improving the documentation, submitting bug reports and feature requests, or writing code to improve the security and accessibility of dcbfs.
First of all, we want this to be an open and welcoming envirnonment for all contributers. Please read our code of conduct for guidelines and suggestions.
Also, if you have a suggestion for a major change in the structure of the codebase, please open an issue describing the change insetad of a pull request (as that would likely be closed).
A good way to start contributing is fixing small bugs and typos, and discussing the project structure/philosophy. This way you can familiarize yourself with the project before making larger changes.
Here are a couple of tutorials about how to make a pull request:
- http://makeapullrequest.com/
- http://www.firsttimersonly.com/
- https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
Now you're ready to submit a pr. Feel free to ask for advice, we'd be happy to help!
If you want to submit a contribution, first make a fork of the repository. Make your changes on your fork, and when you believe your fork is in the best possible state, submit a pull request.
If you find a security vulnerability, do NOT open an issue. Email [email protected] instead and describe the exact steps you took and what was compromised.
If it's not a security problem, please open an issue describing what happened.
When filing an issue, make sure to answer these questions:
- What version of dcbfs are you using (when did you install it)?
- What operating system and processor architecture are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?
First, read the README
The outline and philosophy of this project is explained here. If you have a suggestion or concern about the code, this is a good place to check if it is already addressed.
To suggest a new feature or enhancement, please open an issue describing it and why it is better than the current structure. We'll review your proposal and get back to you about possibly submitting a pr.
If you submit a pr, we'll review it and probably provide some feedback before merging it. Pay attention to comments and suggested changes. Once everything is perfect, we'll merge your pr.
If you need to discuss something that isn't appropriate for a github comment thread, you can email Darcy Meyer ([email protected]).