helpers
helpers copied to clipboard
On-board ehaabbasil
-
[x] Contributor: Fork the repos
-
[x] Contributor: Set up the development environment following instructions in
intern.set_up_development_on_laptop.how_to_guide.md -
[x] Contributor: Carefully study all the documents in the must-read list:
- [x] *Carefully study all the documents in the must-read list
- [x] General rules of collaboration
- [x] Coding style guide
- [x] How to write unit tests
- [x] How to run unit tests
- [x] Creating a Jupyter Notebook
- [x] What to do before opening a PR
- [x] Code review process
- [x] Git workflows and best practices
- [x] GitHub organization
- [x] Tips for writing documentation
- They will help you get up to speed with our practices and development style
- Read them carefully one by one
- Ask questions
- Memorize / internalize all the information
- Take notes
- Mark the reading as done
- Open a GH issue/PR to propose improvements to the documentation
Final checks
- [x] Intern: Exercise all the important parts of the systems
- [x] Create a GitHub issue
- [x] Check out and pull the latest version of the repo code
- [x] Create a branch
- [x] Run regressions (
i run_fast_tests) - [x] Run Linter (
i lint --files="...") - [x] Start a Docker container (
i docker_bash) - [x] Start a Jupyter server (
i docker_jupyter) - [x] Do a PR
- Tip: a good approach to the "final checks" is to perform all the steps (opening an issue, creating a branch, filing a PR) for something very small but useful -- like fixing a typo in the docs.
Noted. Thank you