Contributing to django-galleryfield
We want to make contributing to this project as approachable and transparent as possible, whether it’s:
Reporting a bug
Discussing the current state of the code
Submitting a fix
Proposing new features
Becoming a maintainer
Our Development Process
We use github to host code, to track issues and feature requests, as well as accept pull requests.
Pull requests are the best way to propose changes to the codebase (we use Github Flow ). We actively welcome your pull requests:
Fork the repo and create your branch from
If you’ve added code that should be tested, add tests.
If you’ve changed APIs, update the documentation.
Ensure the test suite passes.
Make sure your code lints.
Issue that pull request!
Specifically, if you were testing locally, run:
git clone https://github.com/dzhuang/django-galleryfield.git cd django-galleryfield pip install -r requirements.txt pip install isort flake8 # Your modification to the code # tests pytest . # Sorting imports isort galleryfield dem demo_custom tests # Python code styling check flake8
Notice that we are using
rollup.js to bundle assets (except
./rollup.config.js: the rollup run script
./galleryfield/static/js/jquery.fileupload-ui-gallery-widget.js: the major scripts file
The process follows:
npm install # Your modification to the code npm run build
We use GitHub issues to track public bugs. Report a bug by opening a new issue ; it’s that easy!
Great Bug Reports tend to have:
A quick summary and/or background
Steps to reproduce
Give sample code if you can. Includes sample code that anyone with a base setup can run to reproduce what you were seeing
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)
By contributing, you agree that your contributions will be licensed under its MIT License.
This document was adapted from the open-source contribution guidelines for Facebook’s Draft .