Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 2.49 KB
Raw

Contributing to Guidebooks

Contributions are welcome.

Reporting Issues

Please report all issues and suggestions in the Issue Tracker. Check to see if the issue already exists before adding a new one. Mention related issues by using GitHub's #Number notation.

Provide details

  • Provide a descriptive title
  • Which trail?
  • Is it a data or format problem?
  • What trail mile is the issue at?
  • What is the problem?

Add or edit a guidebook.

Please send a pull request to the master branch.

  • Get a GitHub account
  • Fork the Guidebooks repository.
  • Download and install GitHub Desktop
  • Log in to GitHub Desktop and Clone the repository
  • Create a branch from master.
  • Make changes to the local copy on your computer using the appropriate software.
  • Commit the updates with a summary and detailed list of changes. Be sure to uncheck files you didn't mean to change
  • Continue to make changes and commit frequently until the change is ready to be added
  • From github.com, navigate to your branch and create a New Pull Request. Add a helpful message, be sure to tag related issues with #Number and notify contributors with @contributor.
  • Create a pull request to pull the changes from your branch to the Guidebooks master.
  • Monitor the status of the Pull Request and join in the discussion

Guidelines

  • Ask questions about the project and its workflow before you start a bunch of work
  • All text should be as accurate as possible
  • Keep everything professional looking
  • Try to be consistent with what is already there, unless you are trying to deliberately improve the style.

Software

  • Elevation profiles are generated with the latest version of ProfileMaker
  • Some GPX editors, like Basecamp, do not properly use the GPX format and do not make usable output for ProfileMaker. One working editor is GPX_Editor.
  • Images are edited with GIMP 2.8 and saved in it's native .xcf format. They are also exported for use as .png
  • Maps are made in QGIS 2.18 and saved in its native .qgs. They are exported as .png for use.
  • Supplemental pages are made in Scribus 1.4 and saved in its native .sla as individual pages. Final pages are exported as .png
  • The end product is linking all the .png files into a .pdf