Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.79 KB

Contributions

Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

Get Mentoring Support

If you are new to the project, you might need some help in understanding how the dynamics of the community works and you might need to get some mentorship from other members of the community - mostly committers. Mentoring new members of the community is part of committers job so do not be afraid of asking committers to help you. You can do it via comments in your Pull Request, asking on a devlist <https://groups.google.com/g/yourlabs>__ .

Report Bugs

Report bugs through GitHub <https://github.com/yourlabs/django-cities-light/issues>__.

Please report relevant information and preferably code that exhibits the problem.

Fix Bugs

Look through the GitHub issues for bugs. Anything is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues labeled "kind:feature" <https://github.com/yourlabs/django-cities-light/labels/kind%3Afeature>__ for features.

Any unassigned feature request issue is open to whoever wants to implement it.

Improve Documentation

The project could always use better documentation, whether as part of the official docs, in docstrings, docs/*.rst or even on the web as blog posts or articles.

Submit Feedback

The best way to send feedback is to open an issue on GitHub <https://github.com/yourlabs/django-cities-light/issues/new/choose>__.

If you are proposing a new feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)