JOJ/JOJ3
24
5
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

fix: typo

张泊明518370910136 2024-10-08 19:20:41 +08:00
parent 1bf12af6ba
commit 3a75819046
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Introduction-to-JOJ3.md

@ -11,11 +11,11 @@ JOJ3 takes advantage of the latest technologies in order to secure and simplify
## Basic usage ## Basic usage
On every single push heath-check is run, while other layers are activated based on the needs defined by the Teaching Team (TT) and your commit message. At the user level there is nothing to configure or do aside of using a proper commit message. On every single push, heath-check is run, while other layers are activated based on the needs defined by the Teaching Team (TT) and your commit message. At the user level, there is nothing to configure or do aside of using a proper commit message.
### Commit messages ### Commit messages
All commit messages are expected to comply with [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specifications. JOJ3 parses you commit and based on its content will tiger different set of actions. Any commit must be in the format All commit messages are expected to comply with [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specifications. JOJ3 parses your commit message and based on its content will trigger different sets of actions. Any commit must be in the format
``` ```
type(scope): message type(scope): message
``` ```
@ -23,20 +23,20 @@ type(scope): message
The `type` must be one of The `type` must be one of
- `feat`: the commit adds a new feature - `feat`: the commit adds a new feature
- `fix`: the commit fix a bug - `fix`: the commit fixes a bug
- `docs`: the commit only contains changes related to documentation - `docs`: the commit only contains changes related to documentation
- `style`: the commit only adjusts the style, eg. add spaces, tabs, reformat existing code - `style`: the commit only adjusts the style, eg. add spaces, tabs, reformat existing code
- `refactor`: changes to the code which neither add a feature nor fix a bug - `refactor`: changes to the code which neither add a feature nor fix a bug
- `perf`: a commit which helps improving performance - `perf`: a commit which helps improve performance
- `test`: adding or correct tests - `test`: adding or correcting tests
- `build`: changes affecting the build system, eg. Makefile, dependencies - `build`: changes affecting the build system, eg. Makefile, dependencies
- `ci`: commit related to Continuous Integration (CI), eg. Gitea actions configuration - `ci`: commit related to Continuous Integration (CI), eg. Gitea actions configuration
- `chores`: changes not modifying source code or tests cases - `chores`: changes not modifying source code or test cases
- `revert`: revert a previous commit - `revert`: revert a previous commit
The `scope` is defined and provided by TT for each task or each assignment. For instance it could be `hw2/ex4` for homework 2 exercise 4 or `p1/m3` for project 1 milestone 3. If you are unsure of the scope of a task reaching to TT. The `scope` is defined and provided by TT for each task or each assignment. For instance, it could be `hw2/ex4` for homework 2 exercise 4 or `p1/m3` for project 1 milestone 3. If you are unsure of the scope of a task reaching to TT.
The `message` should concisely describe the changes included in this commit. If `message` contains the keyword `joj` then the your work will be tested for correctness trhough the online judge layer of JOJ3. The `message` should concisely describe the changes included in this commit. If `message` contains the keyword `joj` then your work will be tested for correctness through the online judge layer of JOJ3.
#### Examples #### Examples
@ -71,11 +71,11 @@ Once you have pushed your work connect to Gitea and check the issue tab for all
## More advanced usage ## More advanced usage
This sections briefly previews other ways to interact with and use JOJ3. This section briefly previews other ways to interact with and use JOJ3.
### Pull requests ### Pull requests
JOJ3 doesn't change the way to handle (open, create, review, and approve) Pull Requests (PR). We however recommend to select the option `Create squash commit`. Then make sure to set the commit message to a meaningful string, eg. `feat(h1): ready for submission` and click `Clear squash commit`. Finally click again on `Create squash commit` to complete the PR. JOJ3 doesn't change the way to handle (open, create, review, and approve) Pull Requests (PR). We however recommend selecting the option `Create squash commit`. Then make sure to set the commit message to a meaningful string, eg. `feat(h1): ready for submission`, and click `Clear squash commit`. Finally, click again on `Create squash commit` to complete the PR.
### Faster submissions ### Faster submissions
@ -94,10 +94,10 @@ joj-submit h2/e5 more tests # creates and pushes commit test(h2/e5): joj more te
### Contributing ### Contributing
JOJ3 is still in heavy development and needs your help! You can contribute in two main ways: JOJ3 is still in heavy development and needs your help! You can contribute in two main ways:
- Provide feedback on your experience using JOJ3 and help improving it: contact your TT who will get in touch with JOJ3 developers - Provide feedback on your experience using JOJ3 and help improve it: contact your TT who will get in touch with JOJ3 developers
- Join JOJ3 development team: contact Manuel or Boming on Mattermost - Join JOJ3 development team: contact Manuel or Boming on Mattermost
The core part of JOJ3 is written in Go while Joint-teapot part in coded in Python. While the software in itself is very advanced, its architecture is not only very simple, making JOJ3 easily accessible even to motivated freshmen, but also very flexible thereby allowing modular development. The most important requirements to join the development teams are a strong motivation to learn more, the ability to work as part of an international team of developers, as well as the ability to accept and follow directions. The core part of JOJ3 is written in Go while Joint-Teapot part is coded in Python. While the software in itself is very advanced, its architecture is not only very simple, making JOJ3 easily accessible even to motivated freshmen, but also very flexible thereby allowing modular development. The most important requirements to join the development teams are a strong motivation to learn more, the ability to work as part of an international team of developers, as well as the ability to accept and follow directions.