Django site for Philly DSA
All contributors agree to abide by the Philly DSA Code of Conduct, which can be found at: TKTK.
Clone the repository with:
git clone
git checkout develop
git submodule init
git submodule update
That should be it.
Install requirements. If you're using pyenv:
make dev
Or by running:
pip install -r requirements/dev.txt
This will install all the required dependencies for the project. We use pre-commit hooks, so if you didn't install by make dev, run pre-commit install in the root directory.
Development occurs on the develop branch and master is reserved for releases. See A Successful Git Branching Model for rationale. Git Flow AVH is one tool to help manage this workflow. YMMV so use whatever you're comfortable with and it'll work out in the end.
Install gulp globally with:
npm install gulp -g
Install local dependencies with:
npm install
This is just for livereload at the moment, so feel free to ignore if it's annoying.
Run:
make dev
python manage.py migrate
python manage.py createsuperuser # follow prompts
make gulp # open another terminal and:
make server
and you should be good to go.
Please ensure that all contributions have corresponding test coverage. Running make test will run all the tests for the project and output a coverage report.
We use the following naming conventions, which help to keep things organized:
- Branch name for production releases:
master - Branch name for "next release" development:
develop - Feature branch prefix:
feature/ - Bugfix branch prefix:
bugfix/ - Release branch prefix:
release/ - Hotfix branch prefix:
hotfix/
To submit a pull request, start new branch, commit your changes, and then submit the PR. We're all volunteers, so review may not be immediate (it doesn't mean you're being ignored!), but if it's been a while, ping a collaborator.
Feel free to submit any issues you come across, whether they're technical or something about installation or usage is unclear - both are important and welcome.
We use issue templates, which may not be appropriate for all issues, so take the template with a grain of salt.