- File an issue first so we are aware about change you want to make and possibly guide you.
- Use usual steps to make changes just like other GitHub projects.
- Clean compile your changes on Windows or Linux and test basic simulator operations.
- When your pull request is created, you might get prompted to one-time sign Contributer License Agreement (CLA) unless changes are minor. It's very simple and takes less than a minute.
- Watch for any comments on your pull request.
- Do not make just cosmatic changes. We will generally reject pull requests with only cosmatic changes.
- Limit your changes to small number of files. We need to review every line of your change and we can't reasonably do that if you make requests with 10s of files.
- Do not change code in the deps folder! That's our dependencies and untouchable unless there is very strong reason for it.
- Make sure your changes conforms to style around it. Take a look at our short and sweet guidelines.
- Do not include OS specific header files. Large portions of our library is header-only and we want to keep all our headers clean..
We have the sweet and short coding guideline document you might have yet seen.