Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

71 lines (50 loc) · 2.77 KB
Raw

Contributing to GleoJSON

Thank you for your interest in contributing to GleoJSON! We welcome contributions from the community to help improve and grow this project. This document outlines the process for contributing to GleoJSON.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/guria/gleojson.git
cd gleojson
  3. Set up your development environment with Gleam. If you haven't installed Gleam yet, follow the official installation guide.

Making Changes

  1. Create a new branch for your feature or bug fix: 
    git checkout -b your-feature-branch
  2. Make your changes in the relevant files under the src/ directory.
  3. Add or update tests as necessary in the test/ directory.
  4. Run the tests to ensure your changes don't break existing functionality: 
    gleam test
  5. Update the documentation if your changes affect the public API or user-facing features.

Submitting Changes

  1. Commit your changes with a clear and descriptive commit message: 
    git commit -am "Add a brief description of your changes"
  2. Push your branch to your fork on GitHub: 
    git push origin your-feature-branch
  3. Open a pull request against the main repository's main branch.
  4. In your pull request description, explain the changes you've made and why they're necessary.

Code Style and Standards

  • Write clear, concise comments and documentation.
  • Ensure your code is well-tested.

Reporting Issues

If you find a bug or have a suggestion for improvement:

  1. Check the GitHub Issues to see if it has already been reported.
  2. If not, open a new issue, providing as much detail as possible about the problem or suggestion.

Community and Communication

  • Join the Gleam Discord for discussions and questions.
  • Be respectful and considerate in all interactions.

License

By contributing to GleoJSON, you agree that your contributions will be licensed under the project's LICENSE file.

Thank you for contributing to GleoJSON!

Developer Certificate of Origin

By making a contribution to this project, I certify that:

  1. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  2. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or