...
In order to develop code for the inspectIT a contributor needs to apply the following development process:
| Table of Contents |
|---|
GitHub Setup
A prerequisite to work on inspectIT is that a contributor needs to have a working GitHub account. Please use the https://github.com/join page to create an account if you don't have one.
Once the account has been created, you should create a SSH key that you will use on the GitHub. Detailed information on creating the key can be found at https://help.github.com/articles/generating-ssh-keys/.
Fork inspectIT project on the GitHub
First thing a contributor need to do is fork the official inspectIT repository on the GitHub. Each contributor of inspectIT has his own forked repository that serves for pushing the code changes contributor developed. The official inspectIT repository is located at https://github.com/inspectIT/inspectIT. In the top right corner you will see the ability to fork the repository. Note that you must have a user on GitHub and be logged-in to perform this action.
Make a local clone of the forked repository
After the fork has been created, a contributor should create a local clone of the new forked repository. This can be done by executing:
...
| Code Block |
|---|
git remote add inspectit_main git@github.com:inspectIT/inspectIT.git |
Implement changes & commit
Once you have the inspectIT source code via git available on your local machine, you can start coding and implementing changes. We advise that you check the Development Environment page in order to correctly setup the development environment. Please develop code thinking on Quality.
...
| Code Block |
|---|
INSPECTIT-xxx, INSPECTIT-yyy: Description of the changes |
Check that the build is working
When you have finished implementing the changes it's advised to do a final check prior to pushing the code. This can be easily done by executing the build on the Project you have been working on. In most cases it's enough to run:
...
This would build the project (with your changes) and execute functional testing and static code analysis checks. You must make sure that no step of this ant build is failing and that build can be completed successfully.
Create a pull request
When everything is set, you can push the branch containing the changes to your previously forked repository. If you followed all the steps from this page, this remote repository should be named origin in your local git:
...