Skip to content
This repository was archived by the owner on Oct 4, 2022. It is now read-only.

Commit 1d2e621

Browse files
committed
Create contributing guide
1 parent d323c26 commit 1d2e621

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
- Come up with an idea and put it on the spreadsheet
4+
- Create your challenge and create your yaml file, use the one from the [example chall](https://github.com/BCACTF/bcactf-3.0/blob/main/example/chall.yaml) as a guide
5+
- Create a branch, name it in the format of `category/chall-name`
6+
7+
![Create Branch button](https://media.discordapp.net/attachments/829826615269785613/956348634000130069/unknown.png "Create Branch button")
8+
9+
![Naming branch](https://media.discordapp.net/attachments/829826615269785613/956348738811609158/unknown.png "Naming branch")
10+
11+
- Switch to your branch and publish it
12+
13+
![Switch/Publish Branch](https://media.discordapp.net/attachments/829826615269785613/956349386655416431/unknown.png "Switch/Publish Branch")
14+
- Commit and push your chall, make sure to have no compiled binaries
15+
16+
![New Pull Request](https://media.discordapp.net/attachments/829826615269785613/956382914000609380/unknown.png "New Pull Request")
17+
- Open a pull request, assign reviewers, labels, etc
18+
- We will review your challenge during club. Leave constructive criticism for your peers!
19+
- Do not merge your own challs, leave it to admin. We will not merge challs until they get at least two reviews.

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@
66
- Don't commit stuff like `node_modules`, compiled binaries, etc.
77
- Include a solvepath
88
- Send a PR and tag category leads for review
9+
- Look at [CONTRIBUTING.md](CONTRIBUTING.md) for more information

0 commit comments

Comments
 (0)