mirror of
https://github.com/loot/loot.github.io.git
synced 2026-07-27 14:13:30 -07:00
Updated Contributing To LOOT (markdown)
This commit is contained in:
@@ -10,9 +10,9 @@ A text editor such as [Notepad++](http://notepad-plus-plus.org/) is highly recom
|
||||
|
||||
If you're not a member of the LOOT team, you won't be able to make changes to the official code repositories directly. Instead, you can take advantage of GitHub's Forking system, which is briefly described [here](http://guides.github.com/overviews/forking/).
|
||||
|
||||
Forking is a great way to get to know the project and contribute to it without worrying about making a mistake and breaking something, because someone always has to check your changes before they get included into the official repositories. Make good pull requests and you'll probably be asked to join the team!
|
||||
Forking is a great way to get to know the project and contribute to it without worrying about making a mistake and breaking something, because someone always has to check your changes before they get included into the official repositories. Make good pull requests and you'll probably be added to the team so that you can contribute without having to fork.
|
||||
|
||||
*Note*: once your pull request has been accepted and merged into the official repository you forked, we'd recommend deleting your fork. Then, if you want to submit any more changes in the future, just create a new fork. This avoids having to keep your fork [up to date](https://help.github.com/articles/syncing-a-fork).
|
||||
*Note*: Forks need to be [kept in sync](https://help.github.com/articles/syncing-a-fork) with the official repositories. If you don't feel comfortable doing this, you can delete your fork once your pull request has been merged into the official repository, then create a new fork when you next want to submit any changes.
|
||||
|
||||
### Making Changes
|
||||
|
||||
@@ -24,10 +24,10 @@ If you're editing a masterlist, see the [[Masterlist Editing|Masterlist-Editing]
|
||||
|
||||
### Contributing as a Team Member
|
||||
|
||||
As a team member, contributing becomes a little different to the above - instead of forking a repository and cloning your fork, you can clone the official repository and make changes to it directly. The process is much the same, but because there are other people who also make changes to the same repository, it becomes a little bit more complicated.
|
||||
As a team member, contributing becomes a little different to the above - instead of forking a repository and cloning your fork, you can clone the official repository and make changes to it directly. The process is much the same, but because there are other people who also make changes to the same repository, there are a few things you should bear in mind so that everyone works together well:
|
||||
|
||||
1. It is vitally important that you make sure that your local repository is in sync with the online repository before and after you make any changes.
|
||||
2. If you're not sure about some changes you're making, or they need to be made in several commits before they're finished, make them in a separate branch, and merge them in when you're finished and you're sure that the changes don't break anything.
|
||||
1. Make sure that your local repository is in sync with the online repository before and after you make any changes.
|
||||
2. If you're not sure about some changes you're making, or they need to be made in several commits before they're finished, make them in a separate branch, and merge them in when you're finished. This helps keeps things tidy and means other commits won't interfere with what you're doing until you're ready to merge back in.
|
||||
3. If you have committed changes to your local repository, and someone else synced their changes to the online repository after you last synced, then you may need to manually merge the changes. You'll know if you have to do this because GfW will give you an error message when you try to sync, in which case see [[Resolving Conflicts|Resolving-Conflicts]].
|
||||
4. You should also have a read of the [[Guidelines|Guidelines]] page to familiarise yourself with the recommendations and team policies detailed there.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user