I have striped off some of the functionality from the app for the contributors to gain some experience and learn the ins and outs of the app. Some of the functionality can be seen in the video below while others was striped before I made the video. the app does not have a pretty UI at the time of writing this document.
- Choose an open issue.
- Make a new branch. I will not accept your pull request if you have made changes on the master branch.
1). Fork the repository using the fork button available on upper right corner.
{width="6.492361111111111in"
height="0.5381944444444444in"}
2). Run the command
“ git clone https://github.com/nataliyah123/TYPHOID_SCREENER.git”
in your CLI / github desktop app / or IDE. This command is used only once, no repetition is needed.
3). Set origin using the command
“git remote add origin your_github_addr”
4). Set upstream using the command
“git remote add upstream https://github.com/nataliyah123/TYPHOID_SCREENER.git”
5). Make a new branch using the command
“git branch your_branch_name”.
6). Or create a branch and check out to your new branch using a single command
“git checkout –b your_branch_name”.
7). Do your coding.
8). Push your code to your github, which is origin using the command
“git push origin your_branch_name”.
9). Pull a pr.
10). When the upstream/typhoid_screener repo changes. You should first checkout to the main/master branch and then either make a pull request directly from the upstream/typhoid_screener.
11). OR update your own origin/your_github main branch by clicking the fetch upstream button.
12). Then make a pull request from your own origin/your_github.
13). If there are conflicts resolve them by adding / removing the lines in the code.
14). Once you are done make a new branch and checkout to that branch. And then code.
The command to run the app in development mode is
"python main.py"