Skip to main content

Contributing Guidelines

First off, thank you for considering contributing to this project. It's people like you that make this project such a great resource.

How Can I Contribute?​

Reporting Bugs​

If you encounter a bug while using the site, please check the issue tracker to see if it has already been reported. If it hasn't, please open a new issue and provide as much information as you can about the bug.

Suggesting Enhancements​

If you have an idea for a new feature or an improvement to an existing feature, please check the issue tracker to see if it has already been suggested. If it hasn't, please open a new issue and describe your idea.

Your First Code Contribution​

If you're looking to make your first code contribution, take a look at the issues labeled good first issue. These issues are relatively easy to resolve and are a good way to get familiar with the project.

Pull Requests​

  1. Fork the repository and create your branch from main.
  2. Add your feature.
  3. Issue that pull request!

Styleguides​

Git Commit Messages​

  • We are using conventional commits. (feat: add maplibre tutorial) Please see this page for more information.
  • Prefix the commit message with one of the following tags:
    • feat: A new feature
    • fix: A bug fix
    • docs: Documentation only changes
    • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
    • refactor: A code change that neither fixes a bug nor adds a feature
    • perf: A code change that improves performance
    • test: Adding missing or correcting existing tests
    • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
  • Try to use the present tense ("add feature" not "added feature")
  • Try to use the imperative mood ("move cursor to..." not "moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Code of Conduct​

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.