Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 2.21 KB

Contributing to DjangoAdminGeomap library

This project use github to host code, to track issues and feature requests, as well as accept pull requests.

You can make contributing to this project, whether it's:

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • What version of the DjangoAdminGeomap and Django is being used.
  • A quick summary and/or background.
  • Steps to reproduce. Be specific! Give sample code if you can.
  • What you expected would happen.
  • What actually happens.
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work).

Propose new features according to the goals of the project

This project solves one simple and common problem: displaying records from the Django database on a map.

All your suggestions for a more flexible and functional display of objects on the map are welcome.

Any other tasks related to geodata and Django are not the goals of this project. For example, geodata processing functions or improvements in the Django admin panel.

All code changes happen through pull requests

Pull requests are the best way to propose changes to the codebase. Github Flow perform quality checks for you code.

  • Fork the repo and create your branch from main.
  • If you've add/change/remove features, update the README.md.
  • If you've added code that should be tested, add tests. 100% test coverage is a fetish of the author of this code ;)
  • Ensure the test suite passes.
  • Make sure your code lints.
  • Issue that pull request!

Any contributions you make will be under the MIT Software License

When you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.