Skip to content

Commit 0d06c27

Browse files
authored
Update CONTRIBUTING.md
1 parent 7d9a3c1 commit 0d06c27

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
1-
If you would like to contribute to the development of AutoSploit please use the `dev-beta` branch from now on.
2-
Once we get a working version up in that branch i will update the `master` branch accordingly.
1+
# Contributing
2+
3+
All contributions to Autosploit are not only welcomed, but highly appreciated, please keep in mind the following while making a pull request:
4+
5+
- Each request should make at least one logical change
6+
- All contributions should be forked from the `dev-beta` branch
7+
- Each request will need to be reviewed before merged, if anything seems weird we will either fix it or ask you to fix it for us
8+
- If you have multiple pushes in one request, please squash them together (or we will before we merge)
9+
- All pull requests that are merged are provided under the same license as the program is, keep the following in mind;
10+
11+
> By submitting code contributions to AutoSploit via Git pull request or other, checking them into the AutoSploit's source code repository, it is understood (unless you specify otherwise) that you are offering the AutoSploit copyright holders the unlimited, non-exclusive right to reuse, modify, and re-license the code. This is important because the inability to re-license code has caused devastating problems for other software projects (such as KDE and NASM). If you wish to specify special license conditions of your contributions, just say so when you send them.
12+
13+
## Getting started
14+
15+
To get started making a contribution please do the following:
16+
17+
- Fork the repository using the fork button
18+
- `git clone https://github.com/<YOUR-NAME>/AutoSploit.git -b dev-beta`
19+
- Edit the code to your liking
20+
- After editing `git branch <YOUR-BRANCH-NAME> && git checkout <YOUR-BRANCH-NAME>`
21+
- Add your commits and comment them
22+
- `git push --set-upstream origin <YOUR-BRANCH>`
23+
- Open a [pull request](https://github.com/NullArray/AutoSploit/pulls)
24+
- Wait for us to check it out
25+
26+
Thank you.

0 commit comments

Comments
 (0)