The project uses the Forking Workflow with Pull Requests. This is experimental for the time being, but is expected to help towards the goal of building a complete documentation and a well-organized repository for future TEDxNTUA websites.
In short:
- Fork the upstream repository and clone it to your local machine.
- Follow the installation instructions.
- Create a branch for the feature you want to work on.
- When finished, push the feature branch to your repository.
- Create a pull request on the upstream repo and describe the changes you've made.
- Participate in discussion between the team members on whether the feature needs improvements or should be merged.
- Repeat!
For a more detailed guide on how to stay in sync with the upstream and avoid conflicts, read this.
English should be used for variable names, docstrings, documentation etc for uniformity.
Pylint is used to enforce proper guidelines:
- PEP 8 compliance.
- Docstrings everywhere :)
RECOMMENDED: To enforce Pylint checking right before each commit, then copy the etc/pre-commit file to .git/hooks/pre-commit. This uses the git-pylint-commit-hook module that is included in the dev-dependencies.
Rules are meant to be broken though, so if you disagree when Pylint complains about something, feel free to edit the pylintrc configuration accordingly.
raise NotImplemented
Check the running projects to find things to work on.