So you want to contribute? That makes you a rock star! :)
Please take 5 minutes to read this and familiarise yourself with these guidelines.
If you've not used github before getting started can be a bit daunting, if you want to propose a feature or fix a bug start by Forking that will create a local copy of rsdns in your github account.
Next create a branch and make your changes in there. Branching not only fits neatly into the github work flow (you'll notice a button appear in github that says "create a pull request for this branch") but it keeps git tidy under the hood. Finally create a pull request (PR). The PR will create an issue for me to review and make it easy to include your suggestions.
If you have a problem with rsdns you can create an issue; please ensure that all issues include an output of the error message and any steps you've tried to fix. Where possible, please suggest a fix via a PR.
All PRs must pass the tests on travis-ci, where possible please include a new test with your PR.
If you have an idea to improve rsdns, that's great!
- Where possible, please implement new features as an additional
-switchor if relevant a new script filersdns-feature.sh - Please do not use any additional dependencies such as Perl or Python.
- All new features must have a unit test, see tests/README.md for more information.
Please ask if you have any problems with these.
English is my native language but that doesn't mean I'm perfect at it, inspection and suggestions from the grammar police are welcome.
- The whitespace in
rsdnsis managed by EditorConfig