Here are the contribution guidelines for the TomorrowDevs projects.
New projects must observe the following rules:
- Every problem must have a README.md file explaining:
- The problem itself
- A reference for the student to some documentation that could help them solve the problem
- Every problem must have one category.
- Every problem README.md file must implement the template file.
- Solutions must be submitted by opening a pull request. The pull request must observe the following rules:
- The branch name should be formatted as
solution/<problem-name>for example:solution/binary-search - The solution must be placed inside of a folder using your name or username. Example:
micheleriva/solution.jsormitch/solution.js - The solution file must be placed inside the "challenges" folder in the problem subdirectory. For example:
/programming-basics/binary-search/solutions/micheleriva/solution.js - Every commit must adopt the conventional commits rules. Learn more here
- A GitHub account
- A Local IDE or Editor
- Git Environment
- A http://toggl.com/ account and Chrome Extension
- A Netlify account
- Create a Github Project connected to the repository
- Read carefully the task description
- Analyze the task, and create relative subtasks to track any requirement and knowledge needed
- Assign an estimate to each created subtask
- Define a deadline for the main task
- Provide a Flowchart within the project
- Where required, involve other members of the community to support you on the development
- When working on a task, move it to the In progress column and start tracking it
- After each task completion, move it to the "Done" column and stop tracking it
- After the main task completion, share the solution (e.g. your GitHub repo) over the community