🎉 First off, thanks for taking the time to contribute!. Any contribution you make will be much appreciated. 🎉
In this project you can see all the tasks for release v0.1
What to do:
1 - Check all the tasks in To do column.
2 - Choose a task that you like.
3 - Add your github username at the beginning of the task.
(Check testing tasks as an example).
4 - Move the task to In progress column.
Note: Please if you stopped working on a task, remove your github username and move it
back to To do column, because other developers might be interested to work on the task
as well.
5 - When you finish the task. Create a pull request to dev branch and add
@mahmoud-abdallah863 as a reviewer. Then move the task to Under Review column.
6 - Wait for review result. We will move the task to done or back to In progress column
depending on the review results.
Aaand that's it.
If you spot a problem with the docs, first search if the issue exists. If not, you can open a new issue with the appropriate labels and explain what you found.
Scan through our existing issues to find one that
interests you. You can narrow down the search using labels as filters.
See labels list for more info.
We don't assign issues to a specific developer, but you can if you have to.
Feel free to add any new feature you feel like doing. Create a branch using this naming convention. Open a PR and add me as a reviewer. I'm more than happy to check it out.
Never create a PR on main branch. Usually you should create it on dev branch,
unless you need to do it on some feature or bug branch.
Open a new issue with the question label, and we will talk about it.
This is the main branch, Github workflows work when committing or creating PR. When we release a new version, it will be from this branch. It is synced with the newly released version.
All under development features and bug fixing is on this branch, will be merged to the main branch, when we want to release a new version.
When creating new features, branches are named as follows: feature/<your_branch_name>.
Notice the underscore. Let's use underscore to separate words.
Branches to fix bugs in the newly released version (main branch).
Same naming convention as for feature/x branches.
Branches to fix any bugs in feature/ or dev branches.