【Read First】 How to contribute to this repo

[fanghuaqi]

How to do a good PR:

1. checkout to master branch first, then pull update from upstream, never directly make changes in master branch
2. checkout new feature branch, such as feature/rvstar_lab5, if you are doing lab5 example for rvstar, the branch name should be reasonable and understandable
3. do changes in this new branch, and commit changes, and do test and review in this branch
   • commit message guide, please follow Git commit guide
   • coding style guide, please follow Code Style Guide
4. if everything is ready in this branch, then open a PR to upstream, and following this PR example

Examples shell commands:

# step 1
## make sure your working tree is clean by check `git status`
git status
## checkout and switch to master branch
## never directly made changes on master branch
git checkout master
## pull changes from upstream master, assume remote upstream is this repo
### only add remote if this remote is not added
git remote add upstream https://github.com/Nuclei-Software/nuclei-board-labs.git
git fetch --all
git pull --rebase upstream master
# step 2
## checkout a feature branch, for example, I want to create a rvstar lab, this lab is lab5
## then I create a branch called feature/rvstar_lab5
git checkout -b feature/rvstar_lab5 upstream/master
# step 3
## do your code here, and add files and commit changes
# step 4
## open a PR to this repo, if you don't know how to create PR, please follow
## https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request

Thanks
Maintainers of this repo