Pantyhose-X
/
nipe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: add information for contributions 

Added some small infos for new comers contribution and a small typo fix in
README file. Nothing functional, only documentation.
master
Bruno Meneguele 2020-02-24 12:26:47 -03:00
parent 09e72bbd08
commit 6fe621590f
2 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
.github/CONTRIBUTING.md vendored
View File

@ -1,9 +1,28 @@
# Contributing to the Nipe!
## License
## Branches
By opening a pull request in this repository, you agree to provide your work under the [project license](../LICENSE.md).
The `master` branch is used only for holding released code of the project. Any
new feature or bugfix **must** be opened against `develop` branch, where some
additional testing is performed before the code lands `master`.
## Testing
For every new feature, please, submit in the same PR a testing code (under
`t/` folder) to cover that completely. Make sure to expand and cover the
added/replaced code as much as possible.
In case it's a functional bugfix (not a typo, commentary, whitespace, ...
issue), make sure to check why the test code didn't trigger the bug before
and, if possible, update the test.
## Great Re-Writings
Open a discussion issue before you begin. So we can listen to what you have to say, and we can provide a referral if it will be worth changing big parts of the project.
Open a discussion issue before you begin. So we can listen to what you have to
say, and we can provide a referral if it will be worth changing big parts of
the project.
## License
By opening a pull request in this repository, you agree to provide your work
under the [project license](../LICENSE.md).

6
README.md
View File

@ -48,8 +48,8 @@
```
COMMAND FUNCTION
install Install dependencies
-f Overwrite Tor config file in /etc/tor/torrc
-c <file> Specify a custom location to install Tors config file
-f Overwrite Tor config file in /etc/tor/torrc
-c <file> Specify a custom location to install Tors config file
start Start routing
stop Stop routing
restart Restart the Nipe process
@ -89,4 +89,4 @@ command to allow DNS port setting to take effect:
### License
- This work is licensed under [**MIT License.**](https://github.com/GouveaHeitor/nipe/blob/master/LICENSE.md)
- This work is licensed under [**MIT License.**](https://github.com/GouveaHeitor/nipe/blob/master/LICENSE.md)