Skip to content
This repository was archived by the owner on Jul 13, 2025. It is now read-only.

Commit 7c1884f

Browse files
committed
Update CONTRIBUTING.md
1 parent a8bc993 commit 7c1884f

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,14 @@ The main folders you would need to know are the [`images`](./Writerside/images)
2929
The below sections will introduce you to the two ways in which you can make changes to the content of handbooks: (1) [Using Writerside](#using-writerside) and (2) [Without using Writerside](#without-using-writerside).
3030

3131
### Using Writerside
32-
1. Install [JetBrains Writerside](https://www.jetbrains.com/writerside/) (version `2024.1`, build `241.15989`) *OR* [Writerside IDE Plugin](https://plugins.jetbrains.com/plugin/20158-writerside?_gl=1%2All6kto%2A_ga%2ANDc2OTczNjcxLjE3MTIyNDEwNzM.%2A_ga_9J976DJZ68%2AMTcxMjI0ODM2Ny4yLjEuMTcxMjI0ODgwOS40Ny4wLjA.) (version `2024.07.241.18775.98`) on a compatible JetBrains IDE.
32+
1. Install the latest version of [JetBrains Writerside](https://www.jetbrains.com/writerside/) *OR* the [Writerside IDE Plugin](https://plugins.jetbrains.com/plugin/20158-writerside?_gl=1%2All6kto%2A_ga%2ANDc2OTczNjcxLjE3MTIyNDEwNzM.%2A_ga_9J976DJZ68%2AMTcxMjI0ODM2Ny4yLjEuMTcxMjI0ODgwOS40Ny4wLjA.) on a compatible JetBrains IDE.
3333
2. [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repository and [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) your forked repository on your local machine.
3434
3. Then, open the cloned repository in the Writerside application or a JetBrains IDE equipped with the Writerside Plugin.
3535
4. Now you can make your changes. Read the [Writerside documentation](https://www.jetbrains.com/help/writerside/getting-started.html#install) to learn how to use it.
36-
5. Please use separate [commits](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits) in which you edit the markdown files and a separate one in which you re-build the website code with your changes.
37-
6. To re-build,
38-
1. Follow the first step in [building locally](https://www.jetbrains.com/help/writerside/local-build.html).
39-
2. You can choose any name for the configuration. Leave `Allow multiple instances` and `Store as project file` unticked.
40-
3. Keep the default directory specification (root directory of the project) and click `Run`.
41-
4. Writerside will generate a compressed archive containing the updated website code. Extract it in the root of the project.
42-
5. Copy the files in the extracted folder and paste them into the root of the project. This should modify the website code files. If asked to whether replace or skip duplicated files, choose replace.
43-
6. Delete the extracted build folder and the build archive.
44-
7. Then, commit the re-build changes. Remember to keep this commit separate from the modification of the markdown content.
45-
7. [Submit your changes](#submitting-changes)
36+
5. [Submit your changes](#submitting-changes)
4637

4738
### Without using Writerside
48-
If you are editing without Writerside, the maintainers of CTF handbooks will have to build the website code themselves. You may add new topics or modify existing ones. Modifying is simple enough, but you will have to go through a few steps for adding new topics.
39+
Although it is not recommended to make changes without using Writerside, it should still be possible.You may add new topics or modify existing ones. Modifying is simple enough, but you will have to go through a few steps for adding new topics.
4940

5041
**Adding new topics**:
5142
1. Taking "Foo Bar Test" as a topic name, you will have to first create a `.md` file in the [`topics`](./Writerside/topics) folder as `Foo-Bar-Test.md` with the following contents:
@@ -74,4 +65,4 @@ After making your changes, you may [submit your changes](#submitting-changes).
7465
---
7566

7667
## Submitting Changes
77-
Please make a [GitHub Pull Request to ctf-handbooks.github.io](https://github.com/CTF-handbooks/ctf-handbooks.github.io/compare) with a clear description of your changes if not explicitly mentioned through the title. Read more about Pull Requests [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
68+
Please make a [GitHub Pull Request to ctf-handbooks.github.io](https://github.com/CTF-handbooks/ctf-handbooks.github.io/compare) with a clear description of your changes if not explicitly mentioned through the title. Read more about Pull Requests [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).

0 commit comments

Comments
 (0)