Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 2.02 KB
Raw

Contributing

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

By participating in this project you agree to abide by its terms.

Developing locally

For those wishing to try, clone this repository into your localhost folder and inside move to the leaflet-elevation folder

  1. git clone https://github.com/raruto/leaflet-elevation (inside your localhost folder, eg. /var/www)

  2. cd leaflet-elevation

  3. npm i

  4. npm run dev

After that you can start developing inside the src and test folders (open "http://localhost/leaflet-elevation/test" in your browser to see your changes).

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: npm i
  3. Make sure the tests pass on your machine: npm t
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests, and make sure the tests still pass
  6. Push to your fork and submit a pull request
  7. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Resources