Update CONTRIBUTING.md with our latest practices
Closed this issue · 5 comments
As more people are working on this project, we should write down the implicit practices we've been using. These include:
- Naming branches
<issue number>-<description> - Formatting with black for python, prettier for javascript and css (separate for event app and react)
- Writing tests
- Creating and claiming issues
- Creating a fork and submitting a PR if you're external to ieee
- Things to keep in mind, such as changing the registration close date in the settings file so you can get to certain pages. Don't commit those changes!
- Links to relevant getting started documentation
Because of the issues in #227, also have people set the DJANGO_SECRET_KEY in their forks so they can run tests. This is a medium-term workaround, in the long run we should get the pull_request_target trigger working.
Don't need to do that anymore, we got things working in #227
Add instructions for maintainers on how to check out pull requests from forks locally. Eg for pr 111:
git fetch origin pull/111/head:pr/111
git checkout 111
Update the PR template too so that it says resolves #<number>, since some people replace the # sign
Perhaps add a "first time section" that links to all the places in the readme to look at, including docker, running yarn run scss, etc.