If you made it here, we are thankful that you think about helping us with this project.
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you have started to work on it so other people don't accidentally duplicate your effort.
If somebody claims an issue but doesn't follow up for more than a week, it's fine to take it over but you should still leave a comment. If there has been no activity on the issue for 7 to 14 days, it is safe to assume that nobody is working on it.
Pull Requests are always welcome. Before working on a large change, please open an issue first to discuss it with the maintainers.
If you are not sure, keep your Pull Requests small. Please limit your Pull Requests to address only a single feature or bug fix. This gives your Pull Request a better chance of getting accepted. Also, it is often best to create two smaller Pull Requests than one big one.
-
Fork the repository.
-
Clone the fork to your local machine and add upstream remote:
git clone https://github.com/<your username>/gps-4g-hat-library.git
cd gps-4g-hat-server
git remote add upstream https://github.com/finamon-de/gps-4g-hat-library.git
- Synchronize your local master branch with the upstream one:
git checkout master
git pull upstream master
- Create a new topic branch:
git checkout -b my-topic-branch
- Make changes, commit and push to your fork:
git push -u origin HEAD
- Go to the repository and make a Pull Request.
The core team is monitoring for Pull Requests. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation.
By contributing your code to this GitHub repository, you agree to license your contribution under the MIT license.