Contributing Guidelines

Pre-request

Before you start modifying the repo, please make sure you have Writerside being installed.

Rules

1. DO NOT directly update on GitHub, or use any IDE/text editor (i.e. vscode) to modify the content.

2. Unless you finished the whole note, DO NOT push the changes to the repo.

3. You should always use Writerside for writing the notes

4. You should always preview and make sure all contents displayed correctly before you push to GitHub

5. Please add your name and contact to the files that you modified/created

6. Unless it is a necessary change, DO NOT merge or push the changes to the main branch.

Some reminder for the first time Writerside user

1. To display an image in the website, you have to put the image to the folder images under Writerside/images

2. The file names must NOT contain any spaces

3. Writerside will create the files under Writerside/topics/, please try to group the topic together before you push to GitHub

4. If you uploaded an image, please run dark_img.sh before push to GitHub. Otherwise the build might fail

Resources

Writerside official document