Contributing to NewSources

Contributing

1. Fork the NewSources repo

1. Clone this repository to your own Github using the fork button at the top-right corner of the Github page. This will create a read-write repository for you. The main NewSources repo is read-only, so your own read-write copy will be your editing stage.

2. Clone your new repo

Clone the repository on your local machine using git commandline or Github for Windows/Mac.

3. Make a feature branch

1. Using the shell, use git checkout -b my-feature
2. Using Github for Mac or Windows, press the new-branch button.

4. Edit

Go forth and edit the files. Make the changes you'd want.

5. Commit to you branch

Use the command-line to commit or use Github for Windows/Mac. Some rules for orderly merges:

1. Bundle changes into one commit.
2. Make sure your commits are not too large. Merging your changes is easier if your changesets are small.
3. Bundle multiple commits into one Pull Request.

For example when adding a Hunter class:

1. Each ability could be one nice commit.
2. Fixing mistakes could be another commit.
3. Renaming everything should also be one commit.
4. These commits together form a nice Pull Request with title "Add Hunter to ACG".

6. Create a Pull Request

Go to your own Github page for your own NewSources repository. You'll see that you've recently pushed branches. Press the big green button and write a description for your changes. Please be verbose. It helps to review your changes. When you are done describing your changes, press "Create pull request".

7. Go to step 3. and create a new feature

So you're all done! Go back to step 3. to add a new feature.

Adding more stuff to your feature branch

After you've created a Pull Request, you will probably receive feedback from fellow developers. They might ask for fixes. Please fix these in the feature branch you created the PR from and add more commits. Just push to your repository to update the PR automatically.