-
Notifications
You must be signed in to change notification settings - Fork 324
Contributing
This documentation covers how to contribute to gitinspector. If you want to contribute to gitinspector, there are many ways to help; writing documentation, adding translations and contributing code in the form of new features or bug fixes. Any help is appreciated.
Contact the the current maintainer and inform that person about the documentation you want to add and why you think it is a good idea. If accepted you will be added as an official contributor to the project and given responsibility for the documentation you add.
Currently, gitinspector supports the following languages:
- Chinese
- English
- French
- German
- Italian
- Polish
- Spanish
- Swedish
If you have good language skills in any unsupported language, you can help with translation of gitinspector to that language. The best way is to simply open a new issue of type "Translation" and tell us about the translation you want to add. If accepted, you will be become an official contributor to the project. Whenever the translation needs updating; someone will re-open the issue and you will be informed if any updates are needed.
If you are a developer and want to contribute code to gitinspector, the best approach is to post patches in the issue tracker or submit a pull request. When the patch or request is accepted; it will be committed under your name to the master branch of the project by one of the developers. Before you start working on a substantial changes, it might be a good idea to start an issue about it to make sure that the maintainer or somebody else isn't already working on the same thing.
Submitted pull requests should generally be rebased onto the master branch, unless they are very substantial and contain a lot of work with many commits. In that case, it might be beneficial and interesting to keep the full history of the pull request intact. If all the commits of a pull request are very small, it might someties be preferable to squash the commits of a pull request into one bigger commit before submitting. The maintainer will guide you if any changes need to be made to your pull request.
If you really want to contribute to gitinspector but can't think of anything to do, you should check out the list of open issues. Just drop a message in an issue to inform the maintainer that you want to work on that issue and he will assign it to you. All the accepted issues that have not yet been started by anyone are up for grabs.
If your work is substantial enough; we might eventually add you to the project as an official code contributor. Consequently; this means that you also get access the the git repository and can push changes on your own.
When coming up with a new code statistic or code metric to add to gitinspector, always consider the original (and main) use case of gitinspector; the grading of student projects. Is the statistics or metric you are about to add of any use when evaluating the performance of an author? If it's not, then it's probably not worth adding and won't be accepted into the code base. A good statistic is a statistic that can be used when evaluating someone.