Skip to content

Commit 7522303

Browse files
updated documentation
1 parent 365e923 commit 7522303

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

DOCUMENTATION.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- [`sync-course.json`](#sync-coursejson)
1515
- [Getting Started](#getting-started)
1616
- [Syncing Content from omegaup.com to this repository](#syncing-content-from-omegaupcom-to-this-repository)
17+
- [Important](#important)
1718
- [Modifying existing Problems Content](#modifying-existing-problems-content)
1819
- [Adding or removing problems to the Couse:](#adding-or-removing-problems-to-the-couse)
1920

@@ -78,13 +79,14 @@ To get started with this project, you will need to have the following prerequisi
7879
- Python 3
7980
- Pip
8081
- Git
82+
- Pipenv
8183

8284
Once you have the prerequisites installed, you can clone the repository and install the dependencies:
8385

8486
```bash
8587
git clone https://github.com/omegaup/public-courses.git
8688
cd public-courses
87-
pip install -r utils/requirements.txt
89+
pipenv install
8890
```
8991

9092
## Syncing Content from omegaup.com to this repository
@@ -106,6 +108,10 @@ git push --force
106108
```
107109
This will push the changes to sync-course branch, now the github action `Sync Course Content` will run which will add a commit made by the Github Actions bot with the latest content from omegaup.com.
108110

111+
### Important
112+
- ```--hard``` flag is required to avoid any merge conflicts if the main branch has some changes which are not in the `sync-course` branch and also to update the `sync-course` branch with the latest changes from the `main` branch.
113+
- ```-force``` flag is required to push the changes to the `sync-course` branch as we are resetting the branch to main branch and hence the history of the `sync-course` branch will be different from the remote `sync-course` branch.
114+
109115
**For Contributors:**
110116
If a contributor want to request syncing of content from the omegaup.com to the course repo in the github, they can raise a pr to targetting the `sync-course` branch with the changes in the `sync-course.json` file to keep a log of the sync request. Once the pr gets merged the `sync-courses` branch will have the a commit made by Github Actions bot containg the latest content from omegaup.com.
111117

0 commit comments

Comments
 (0)