Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

86 lines (54 loc) · 2.8 KB
Raw

Contributing to django-pygwalker

First off, thank you for considering contributing to django-pygwalker!

The following is a set of guidelines for contributing to this project. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Development Setup
  4. Style Guide
  5. License

Code of Conduct

This project and everyone participating in it are governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [maintainer email].


How Can I Contribute?

Reporting Bugs

  • Before creating bug reports, please check the existing issues as you might find that the issue has already been reported.
  • When creating a bug report, please include a clear and concise description of the problem and steps to reproduce it.

Suggesting Enhancements

  • Before creating enhancement suggestions, please check the list of open issues as you might find that the suggestion has already been made.
  • When creating an enhancement suggestion, please provide a detailed description and, if possible, an implementation proposal.

Pull Requests

  • Provide a clear and concise description of your pull request.

  • Ensure you have tested your changes thoroughly.

  • Add/update unittests as nessessary.

  • Make sure code quaility tools run successfully.

    Merging contributions requires passing the checks configured with the CI. This includes running tests, linters, and other code quaility tools successfully on the currently officially supported Python and Django versions.


Development

You can contribute to this project forking it from GitHub and sending pull requests.

First fork the repository and then clone it:

git clone git@github.com:<you>/django-pygwalker.git

Create a virtual environment and install dependancies:

cd django-pygwalker
python -m venv venv
source venv/bin/activate
pip install .[dev]

Unit tests are located under the tests directory and can be executed via pytest:

pytest

Style Guide

Follow the coding style outlined in STYLE_GUIDE.md.


License

By contributing, you agree that your contributions will be licensed under the GNU-3 license.