mirror of
https://github.com/DCC-EX/CommandStation-EX.git
synced 2024-11-23 16:16:13 +01:00
63 lines
3.2 KiB
Markdown
63 lines
3.2 KiB
Markdown
# Contributing
|
|
|
|
Thanks for considering contributing to our project. Here is a guide for how to get started and and a list of our conventions. We will also walk you through the Github command line and Desktop commands necessary to download the code, make changes, and get it included in a next version of the sofware.
|
|
|
|
Before contributing to this repository, please first discuss the change you wish to make via issue, or any other method with the owners of this repository before making a change.
|
|
|
|
Find us on our website at https://dcc-ex.com, on our Discord https://discord.gg/y2sB4Fp or on Trainboard: https://www.trainboard.com/highball/index.php?threads/dcc-update-project-2020.130071/
|
|
|
|
# Development Environment
|
|
|
|
We recommend using PlatformIO IDE for VSCode. If you haven't yet used it, it is an easy to learn and easy to use IDE that really shines for embedded development and the Arduino based hardware we use. For more information go to https://platformio.org/
|
|
|
|
* Download and install the latest version of the Arduino IDE
|
|
* Download and install the latest version of Visual Studio Code from Microsoft
|
|
* Run VSCode and click on the "extensions" icon on the left. Install "PlatformIO IDE for VSCode" and the "Arduino Framework" support
|
|
|
|
If you don't see C/C++ Installed in the list, install that too. We also recomment installing the Gitlens extension to make working with Git and GitHub even easier.
|
|
|
|
You may ask if you can use the Arduino IDE, Visual Studio, or even a text editor and the answer is "of course" if you know what you are doing. Since you are just changing text files, you can use whatever you like as long as your commits and pull requests can be merged in GitHub. However, it will be much easier to follow our coding standards if you have an IDE that can automatically format things for you.
|
|
|
|
# Coding Style Guidelines
|
|
|
|
We have adopted the Google style guidlines. In particular please make sure to adhere to these standards:
|
|
|
|
1. All header files should have #define guards to prevent multiple inclusion.
|
|
2. Use Unix style line endings
|
|
3. We indent using two spaces (soft tabs)
|
|
4. Braces
|
|
|
|
For more information just check our code or read https://google.github.io/styleguide/cppguide.html#C++_Version
|
|
|
|
## Using the Repository
|
|
|
|
1. Clone the repository on your local machine
|
|
2. Create a working branch using the format "username-featurename" ex: "git branch -b frightrisk-turnouts"
|
|
3. Commit offen, ex: "git add ." and then "git commit -m "description of your changes"
|
|
4. Push your changes to our repository "git push"
|
|
5. When you are ready, issue a pull request for your changes to be merged into the main branch
|
|
|
|
## Pull Request Process
|
|
|
|
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
|
|
|
|
## Code of Conduct
|
|
|
|
Be Nice
|
|
|
|
### Enforcement
|
|
|
|
Contributors who do not follow the be nice rule in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
|
|
|
## How Can I Contribute?
|
|
|
|
The DCC-EX Team has several projects and sub teams where you can help donate your epertise. See the sections below for the project or projects you are interested in.
|
|
|
|
### Development
|
|
### Documentation
|
|
### WebThrottle-EX
|
|
### Web Support
|
|
### Organization/Coordination
|
|
|
|
Links to external documentation goes here XXX
|