Skip to content

Latest commit

 

History

History
132 lines (76 loc) · 5.43 KB

CONTRIBUTING.md

File metadata and controls

132 lines (76 loc) · 5.43 KB
Raw

Contributions Welcome

Thanks for your interest in contributing to Navi! Contributing to open source projects like this one can be a rewarding way to learn, teach, and build experience. Not only that, contributing is a great way to get involved with social coding. We are excited to see what amazing contributions you will make, as well as how your contributions will benefit others.

If you are new to contributing to open source projects, the process can be intimidating. Not to worry! To help ensure both you and the community get the most out of your contributions, we've put together the following guidelines.

Table of Contents

  1. Types of Contributions
  2. Ground Rules & Expectations
  3. How to Contribute

Types of Contributions

The common misconception about contributing to an open source project is that you need to contribute code. In fact, there are numerous ways you can directly contribute. To give you some ideas of how you can contribute, here are some examples of the types of contributions we are looking for:

Developers can:

  • Take a look at the open issues and find one you can tackle.

  • Locate and fix bugs.

  • Implement innovative and awesome new features.

  • Help to improve tooling and testing.

Organizers and Planners can:

  • Link to duplicate issues, and suggest new issue labels, to help keep things organized.

  • Go through the open issues and suggest closing old ones.

  • Ask clarifying questions on recently opened issues to move the discussion forward.

  • Help to organize meetups about the project.

Writers can:

  • Help to fix or improve the project's documentation.

  • Contribute to the project's Wiki.

Designers can:

  • Design wire frames, mock-ups, graphical assets, and logos.

  • Put together a style guide to help the project have a consistent visual design.

Supporters can:

  • Answer questions for people on open issues, or about the project in general.

  • Help to moderate discussion boards or conversation channels.

Ground Rules & Expectations

Since the project is constantly being updated with contributions of all sorts, it is important to establish ground rules and as well as expectations. This helps to ensure the best possible experience for users of the Offline Google Maps Navigator application, as well as encourage a positive, helpful, and lively community of active contributors just like you!

Please make sure you read our code of conduct prior to contributing.

How to Contribute

If you'd like to contribute, a good place to start is by searching through the issues and pull requests to see if someone else had a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of the project, you should:

  • Minor Contribution (e.g., typo fix): Open a pull request
  • Major Contribution (e.g., new feature): Start by opening an issue first. That way, other people can weigh in on the discussion and planning before you do any work.

To start making a contribution:

  1. fork the project repository by clicking the fork button on GitHub.fork

  2. clone your forked repository (noob tip: the actual command you type in is everything after the $):

    $ git clone https://github.com/<YOUR-USERNAME>/Navi

  3. Add a new remote that points to the original project so you can sync project changes with your local copy:

    $ git remote add upstream https://github.com/TheDevPath/Navi

  4. Pull upstream changes into your local repositories development branch:

    $ git checkout development
$ git pull upstream development && git push origin development

  5. Create a new branch from the development branch: branch

    IMPORTANT: Make sure you are on the development branch first.

    $ git checkout -b <YOUR-NEW-BRANCH>

  6. Make your contribution to the project code.

  7. Write or adapt tests as needed.

  8. Add or change documentation as needed.

  9. After commiting changes, push your branch to your fork on Github, the remote origin:

    IMPORTANT: Your commit message should be in present tense and should describe what the commit, when applied, does to the code - not what you did to the code.

    $ git push -u origin <YOUR-NEW-BRANCH>

  10. From your forked GitHub repository, open a pull request in the branch containing your contributions. Target the project's development branch for the pull request.

  11. At this point, your contribution has been submitted for review. Please be patient while your contribution is being reviewed as this can take some time. Meanwhile, if there are questions or comments on your contribution, please respond and/or update with future commits.

  12. Once the pull request is approved and merged, you can pull the changes from upstream to your local repository and delete your extra branch(es).

  13. Don't forget to check out more about this project

Happy contributing!