Contributing to rmw
The goal is to use GNU Coding Standards
If you submit a patch, please add yourself (along with your personal link) to AUTHORS.md
See Website Design for information specific to the rmw website.
- Join the chat room so if any problems arise, you can get support.
- Fork the rmw repo
- Clone it to your computer
- When you're ready to work on an issue, be sure you're on the master branch. From there, create a separate branch (e.g. issue_32)
- Make your changes. If you're unsure of some details while you're making edits, you can discuss them with me in the chat room (Slack workspace) or the RMW SourceForge Forum.
- Commit your changes. git-cola is a nice GUI front-end for adding files and entering commit messages (git-cola is probably available from your OS repository).
- Push the working branch (e.g. issue_32) to your remote fork.
- Make the pull request (on the upstream master branch)
- Do not merge it with the master branch on your fork. That would result in multiple, or unrelated patches being included in a single PR.
- If any further changes need to be made, I will discuss them with you.
Periodically, you'll need to sync your repo with the upstream. GitHub has instructions for doing this
- Configuring a remote for a fork
- For step 3 on that page, use https://github.com/theimpossibleastronaut.com/rmw.git for the URL.
- Syncing a Fork
- On that page, it shows how to merge the master branch (steps 4 & 5).
Up-to-date contact information can be found on the Home Page