CONTRIBUTING.md

You want to help? You rock! Now, take a moment to be sure your contributions make sense to everyone else.

Reporting Issues

Found a problem? Want a new feature?

• See if your issue or idea has already been reported.
• Provide a reduced test case or a live example.

Remember, a bug is a demonstrable problem caused by our code.

Submitting Pull Requests

Pull requests are the greatest contributions, so be sure they are focused in scope, and do avoid unrelated commits.

1. To begin, [fork this project], clone your fork, and add our upstream.

   # Clone your fork of the repo into the current directory
   git clone https://github.com/<your-username>/svg4everybody
   # Navigate to the newly cloned directory
   cd svg4everybody
   # Assign the original repo to a remote called "upstream"
   git remote add upstream https://github.com/jonathantenal/svg4everybody
   # Install the tools necessary for development
   npm install

2. Create a branch for your feature or fix:

   # Move into a new branch for a feature
   git checkout -b feature/thing

   # Move into a new branch for a fix
   git checkout -b fix/something

3. Be sure your code follows our practices.

   # Compile the source and watch for changes
   npm run watch

4. Undo changes made to compiled files and rebase all of your commits into one.

   # Undo changes to the compiled files
   npm run clean
   # Combine commits in your branch
   git rebase -i master

5. Push your branch up to your fork:

   # Push a feature branch
   git push origin feature/thing

   # Push a fix branch
   git push origin fix/something

6. Now open a pull request with a clear title and description.

Once your pull is accepted, be sure we add you to the list of contributors.