Skip to content

Commit c4362eb

Browse files
authored
Revert "[02/01/2023] feat - Improved documentation for backend_API"
1 parent 3b2211b commit c4362eb

17 files changed

+3907
-18837
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ vignettes/*.pdf
8585
# Backend API sensitive files
8686
/backend_API/src/*.env
8787
*node_modules/
88-
./backend_API/out
8988

9089
# Frontend
9190
# Logs

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing Guidelines:
2+
3+
We welcome all contributions to the Open Science Community in Saudi Arabia. The contribution can be an [issue report](https://github.com/Open-Science-Community-Saudi-Arabia/Open-Science-Community-in-Saudi/issues)
4+
or a [pull request](https://github.com/Open-Science-Community-Saudi-Arabia/Open-Science-Community-in-Saudi/pulls).
5+
6+
## Contribution workflow:
7+
8+
1. Check that there isn't [already an issue](https://github.com/Open-Science-Community-Saudi-Arabia/Open-Science-Community-in-Saudi/issues) about your idea to avoid duplicating work.
9+
* If there isn't one already, please create one so that others know you're working on it.
10+
11+
2. Fork the [Open-Science-Community-Saudi-Arabia/Open-Science-Community-in-Saudi](https://github.com/Open-Science-Community-Saudi-Arabia/Open-Science-Community-in-Saudi/) to your GitHub account.
12+
13+
3. Clone the forked repository on your local machine.
14+
15+
```bash
16+
17+
git clone https://github.com/<your-github-username>/Open-Science-Community-in-Saudi.git
18+
19+
```
20+
4. Sync the fork, to avoid merge conflicts.
21+
22+
```bash
23+
24+
git remote add upstream https://github.com/Open-Science-Community-Saudi-Arabia/Open-Science-Community-in-Saudi.git
25+
git fetch upstream
26+
git pull upstream master
27+
git push
28+
29+
```
30+
31+
5. Create a new branch with your github username as its name.
32+
33+
```bash
34+
35+
git checkout -b <your-github-username>
36+
37+
```
38+
39+
6. Make the necessary changes and additions / subtractions within your forked repository.
40+
41+
7. Add and commit changes made.
42+
43+
```bash
44+
45+
git add .
46+
git commit -m "commit message"
47+
48+
```
49+
8. Push the changes to forked repository.
50+
51+
```bash
52+
53+
git push origin <branch-name>
54+
55+
```
56+
57+
9. Submit a Pull Request against the `master` branch and wait for the code to be reviewed and merged.
58+
59+
If you're not used to this workflow with git, you can start with some [basic docs from GitHub](https://help.github.com/articles/fork-a-repo/).

backend_API/_book/api.md

Whitespace-only changes.

backend_API/_book/intro.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

backend_API/_book/start.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

backend_API/_book/toc.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

backend_API/book.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

backend_API/jsdoc.json

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)