This document outlines how to contribute to @jj1bdx repositories.
All documents and source code in the repository should be written in English, with American spelling.
- Use the repository issues for general feedbacks, including the bug reports
- Fork the repository on GitHub
- Read the README.md for build instructions
- Create a topic branch from where you want to base your work
- Use the tagged branches as the starting point
- Make commits separated by logical units
- Apply the proper coding and writing styles
- Make sure your commit messages are in the proper format
- Push your changes to a topic branch in your fork of the repository
- Submit a pull request to the repository
First line of the commit messages usually follows the following formats:
- Verb + object (e.g., "Update README.md")
- Target file/branch/function/class + action (e.g., "MultipathFilter: remove redundant spaces")
Keep the first line terse and short. Describe the details after the third line.
Adhere to the license. Do not include the code and document which are not following the license.