nicolas/librenms
1
0
Fork 0
mirror of https://github.com/stylersnico/librenms.git synced 2026-07-28 08:02:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Removed extra spaces from ends of lines.

Browse Source
This commit is contained in:
Jameson Finney
2016-01-30 21:06:58 -05:00
parent d225c85930
commit 437d1fc40c
36 changed files with 198 additions and 198 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/Developing/Using-Git.md
+15 -15
View File
@@ -8,7 +8,7 @@ Some assumptions:
- LibreNMS is to be installed in /opt/librenms
- You have git installed.
- You have a [GitHub Account](https://github.com/).
- You are using ssh to connect to GitHub (If not, replace git@github.com:/yourusername/librenms.git with
- You are using ssh to connect to GitHub (If not, replace git@github.com:/yourusername/librenms.git with
https://github.com/yourusername/librenms.git.
** Replace yourusername with your GitHub username. **
@@ -16,7 +16,7 @@ https://github.com/yourusername/librenms.git.
#### Fork LibreNMS repo
You do this directly within [GitHub](https://github.com/librenms/librenms/fork), click the 'Fork' button near the top right.
If you are associated with multiple organisations within GitHub then you might need to select which account you want to
If you are associated with multiple organisations within GitHub then you might need to select which account you want to
push the fork to.
#### Prepare your git environment
@@ -29,7 +29,7 @@ git config --global user.email johndoe@example.com
```
#### Clone the repo
Ok so now that you have forked the repo, you now need to clone it to your local install where you can then make the
Ok so now that you have forked the repo, you now need to clone it to your local install where you can then make the
changes you need and submit them back.
```bash
@@ -50,7 +50,7 @@ Now you have two configured remotes:
- upstream: This is the main LibreNMS repository and you can only pull changes.
#### Workflow guide
As you become more familiar you may find a better workflow that fits your needs, until then this should be a safe
As you become more familiar you may find a better workflow that fits your needs, until then this should be a safe
workflow for you to follow.
Before you start work on a new branch / feature. Make sure you are upto date.
@@ -61,19 +61,19 @@ git pull upstream master
git push origin master
```
Now, create a new branch to do you work on. It's important that you do this as you are then able to work on more than
one feature at a time and submit them as pull requests individually. If you did all your work in the master branch then
Now, create a new branch to do you work on. It's important that you do this as you are then able to work on more than
one feature at a time and submit them as pull requests individually. If you did all your work in the master branch then
it gets a bit messy!
Ideally you want to create your new branch name based of the issue number. So firstly create an issue on
[GitHub](https://github.com/librenms/librenms/issues) so that others are aware of the work going on. If the issue number
Ideally you want to create your new branch name based of the issue number. So firstly create an issue on
[GitHub](https://github.com/librenms/librenms/issues) so that others are aware of the work going on. If the issue number
you created is 123 then use issue-123 as the branch name.
```bash
git checkout -b issue-123
```
Now, code away. Make the changes you need, test, change and test again :) When you are ready to submit the updates as a
Now, code away. Make the changes you need, test, change and test again :) When you are ready to submit the updates as a
pull request then commit away.
```bash
@@ -89,20 +89,20 @@ git push origin issue-123
If after do this you get some merge conflicts then you need to resolve these before carrying on.
Now you will be ready to submit a pull request from within GitHub. To do this, go to your GitHub page for the LibreNMS
repo. Now select the branch you have just been working on (issue-123) from the drop down to the left and then click
Now you will be ready to submit a pull request from within GitHub. To do this, go to your GitHub page for the LibreNMS
repo. Now select the branch you have just been working on (issue-123) from the drop down to the left and then click
'Pull Request'. Fill in the details to describe the work you have done and click 'Create pull request'.
Thanks for your first pull request :) Now, that might have been a simple update, if things get a bit more complicated
then you will need to break down your pull request into separate commits (still a single pull request). This is usually
Thanks for your first pull request :) Now, that might have been a simple update, if things get a bit more complicated
then you will need to break down your pull request into separate commits (still a single pull request). This is usually
done when:
- You want to add / update MIBS. Do this in a separate commit including the link to where you got them from.
- You are adding say 3 related features in one go, try and break them down into 3 separate commits.
- Icons for new OS support need to be added as a separate commit including a link to where you got the logo from.
Ok, that should get you started on the contributing path. If you have any other questions then stop by our IRC Channel
on Freenode ##librenms.
Ok, that should get you started on the contributing path. If you have any other questions then stop by our IRC Channel
on Freenode ##librenms.
[1]: http://gitready.com
[2]: http://git-scm.com/book