Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tri2820 authored Oct 21, 2024
1 parent 9ad500d commit b6b71c8
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This is the organisation space for 2024 seminar course.

### For Authors

#### How to create pull request?
#### How to create a pull request

##### Step 1 : Clone the repository

Expand All @@ -39,11 +39,8 @@ git checkout -b <new-branch-name>

##### Step 3 : Add your article

1. Create a folder in the `2024` directory.

2. The name of the folder follows the pattern: `topic-name`, such as `rices-theorem`.

3. Then create a Markdown file (exactly named `article.md`).
1. Create a folder in the `2024` directory with the same name as your topic (e.g. `/2024/rices_theorem`).
2. Create a Markdown file (exactly named `article.md`) (e.g. `/2024/rices_theorem/article.md`).
- 💡 Please use the template below. **The format is required for making the document more machine-readable.**

```markdown
Expand All @@ -58,7 +55,7 @@ git checkout -b <new-branch-name>
- Bob
```

- Don't link the illustration image in the markdown file. Instead, put your illustration (exactly named `illustration.svg`) to your article directory (e.g. at `/2024/rices-theorem/illustration.svg`).
- Don't link the illustration image in the markdown file. Instead, put your illustration (exactly named `illustration.svg`) to your article directory (e.g. at `/2024/rices_theorem/illustration.svg`).

- Commit and push to your previously created branch.

Expand Down

0 comments on commit b6b71c8

Please sign in to comment.