- documentation private
- NONAME(s) (project(s) of computer architecture)
- Each member of the project will fork the main project repository and will work on the stuff s/he has to write.
- Every change should be sent to the main repo as a pull request
- Every change needed to be done will be discussed on the comment sections of the pr.
Because the admin of the repos is me (mahdihaghverdi), no one can commit or merge anything on the main repo (except if there were the need to create multiple repos), therefore anyone who wants to participate in the projects should fork the projects and create a branch with his/her name. like: sinarabiei. Anything s/he would want to do, should be committed on his/her branch. Then s/he will create a pull request for the changes s/he has made. After discussing the changes that should be done to the written doc, the changes will be merged into the main branch.
- Fork the repo
- Clone the repo
$ git switch -c yourname
- do anything you want
$ git add
$ git commit
$ git push
- create a pull request
-
- To create a nice and high quality documentation (in pdf format) LaTeX will be used as the main software of the project.
- The format that everyone will use for self-written document is just the simple txt file. Any LaTeX related stuff will be done by me (mahdihaghverdi).