CONTRIBUTING.md

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Hawatel/ionic1-starter. This project is intended to be a safe, welcoming space for collaboration, and contributors.

1. Fork the project, clone your fork, and configure the remotes:

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/ionic1-starter
   # Navigate to the newly cloned directory
   cd ionic1-starter
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/Hawatel/ionic1-starter

2. If you cloned a while ago, get the latest changes from upstream:

   git checkout master
   git pull upstream master

3. Create a new topic branch (off of master) to contain your feature, change, or fix.

   IMPORTANT: Making changes in master is discouraged. You should always keep your local master in sync with upstream master and make your changes in topic branches.

   git checkout -b <topic-branch-name>

4. Commit your changes in logical chunks. Keep your commit messages organized, with a short description in the first line and more detailed information on the following lines. Feel free to use Git's interactive rebase feature to tidy up your commits before making them public.

5. Make sure all the tests are still passing.

   npm test

6. Push your topic branch up to your fork:

   git push origin <topic-branch-name>

7. Open a Pull Request with a clear title and description.

8. If you haven't updated your pull request for a while, you should consider rebasing on master and resolving any conflicts.

   IMPORTANT: Never ever merge upstream master into your branches. You should always git rebase on master to bring your changes up to date when necessary.

   git checkout master
   git pull upstream master
   git checkout <your-topic-branch>
   git rebase master

Thank you for your contributions!