-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add content to contributing guidelines
- Loading branch information
Showing
1 changed file
with
44 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,49 @@ | ||
# Contributions | ||
|
||
Feel free to create pull requests for the following: | ||
Thanks for taking the time to understand how contributions work for the Chowist project. | ||
|
||
There are three general roles for contributing: | ||
|
||
- As a submitter | ||
- As a reviewer | ||
- As a contributor | ||
|
||
Look below for guidelines on each type of role. | ||
|
||
## Submitters | ||
|
||
Feel free to create pull requests for the following changes: | ||
|
||
- Enhancements to Django application logic | ||
- Additional media content (JPG, SVG, etc.) | ||
- Additional restaurants for restaurant fixture | ||
- Enhancements to Django templates | ||
- Enhancements to documentation | ||
- Additions to static files (JPG, SVG, etc.) | ||
- Additions to restaurant fixture | ||
|
||
Before submitting a pull request, follow the steps below to ensure that the review process goes smoothly. | ||
|
||
### Check Python formatting | ||
|
||
Run `black chowist places portal` to cleanup most formatting inconsistencies. | ||
|
||
Run `flake8` to look for remaining code to fix manually. | ||
|
||
### Check HTML formatting | ||
|
||
Verify that HTML uses two-space indents. | ||
|
||
Verify that CSS follow the `kebab-case` convention. | ||
|
||
### Check application correctness | ||
|
||
Run `python manage.py test` to verify core logic. | ||
|
||
Run `python manage.py runserver` and click through pages to verify workflows. | ||
|
||
## Reviewers | ||
|
||
Follow the repository's code of conduct while reviewing pull requests. | ||
|
||
## Contributors | ||
|
||
As you review pull requests, please follow the repository's code of conduct. | ||
Create a pull request indicating interest in becoming a project contributor. |