We're thrilled that you're interested in contributing to RTRMON! This document provides a set of guidelines for contributing to RTRMON. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
RTRMON is licensed under the Unlicense, a license with no conditions whatsoever which dedicates works to the public domain.
How Can I Contribute? For those wishing to contribute to RTRMON, please make your mods to the "rtrmon.sh" file under the "develop" branch. For more info, please see below:
Reporting Bugs
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as much detail as possible.
- Provide specific examples screenshots or logs to demonstrate the steps
Suggesting Enhancements
- 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 much detail as possible.
Your First Code Contribution
- Pull requests are the method for submitting changes. Here's the general process:
- Fork the repository.
- Create a new branch in your fork (git checkout -b feature/my-new-feature).
- Make your changes.
- Commit your changes (git commit -am 'Add some feature').
- Push to the branch (git push origin feature/my-new-feature).
- Create a new Pull Request.
Pull Request Guidelines
- Write clear and concise commit messages.
- Include links to existing BUGS or REQs when possible.
- Include screenshots and logs whenever possible.
- End all files with a newline.
Documentation Styleguide
- Keep language simple and clear.
More Questions?
- Feel free to ask for help if you need it, either via issues or through the provided contact owner @VictorJp