Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 2.21 KB
Raw

Contributing to Maptime.io

We'd love for you to contribute and help make Maptime.io better! Here are some guidelines we'd like you to follow:

Code for Conduct

Help us keep Maptime open and inclusive. Please read and follow our Code of Conduct.

Need a question answered?

If you have questions on contributing to Maptime.io, direct them to one of the following:

Found an issue?

If you find a bug, or issue in the documentation, you can help us out by creating a new issue on Github. Pull Requests are always welcome!

Want to contribute without writing code?

Help us move the abs-of-cartography over to our glossary. Each entry in the wiki should have an entry in the website's glossary. The format is as follows:

# Add a term to the glossary:
- term: (string)
  definition: (html string)
  tags: (array)
  image: (optional)
    src: Filename (string) -- PLACE IMAGES IN `/img`
    alt: For screen readers (string)

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

  • Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

  • Make your changes in a new git branch

    git checkout -b my-fix-branch master

  • Commit your changes using a descriptive commit message

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Push your branch to GitHub:

    git push origin my-fix-branch

  • In GitHub, send a pull request to maptime.github.io:master.

That's it, thanks!