Skip to content

Commit 4202ca1

Browse files
committed
[Doc] Move contributing part into own file
1 parent f963499 commit 4202ca1

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Contributing
2+
3+
### New scripts
4+
5+
- **The right place**: The repository should stay clearly structured, to provide a good overview. Each script should have their own directory, containing all relevant files, like screenshots and documentation.
6+
- **Permissions**: Make sure you are allowed to share the script with the public. Publish it under the same [license](LICENSE) of this repository. By comitting/posting pull requests, you agree with this.
7+
- **Documentation**: Your shared script contains enough documentation/instructions that other users are able to easily understand the purpose and are able to use it without a lot of guesswork.
8+
- **Stay clean**: Your code should be as clean, smart and understandable as possible. Prevent having any magic, encrypted or obfuscated code.
9+
10+
### Modifying existing scripts
11+
12+
- **Credits**: Please respect previous authors and leave them intact. If you feel you've done great enhancements to existing scripts, feel free to add yourself to the authors list.
13+
- **Compatibility**: Don't forget about backwards-compatibility. Try not to break existing scripts. If you're doing changes regarding parameters, dependencies or any other major changes, please create a new script directory or new files within the same folder.
14+
15+
Okay with the few points above? Great! Go ahead and create a pull request with your contribution. Thanks a lot! :-)

README.md

+2-14
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,8 @@ In case...
1818

1919
... please head over to the issues section and [report an issue](https://github.com/royalapplications/toolbox/issues). Support is provided on a best-effort basis from us and the original script authors.
2020

21-
## Contributions
21+
## Contributing
2222

2323
Have scripts to share with the community? Great! Pull requests are very welcome!
2424

25-
When *contributing new scripts*, please check the following first:
26-
27-
- **The right place**: The repository should stay clearly structured, to provide a good overview. Each script should have their own directory, containing all relevant files, like screenshots and documentation.
28-
- **Permissions**: Make sure you are allowed to share the script with the public. Publish it under the same [license](https://github.com/royalapplications/toolbox/blob/master/LICENSE) of this repository. By comitting/posting pull requests, you agree with this.
29-
- **Documentation**: Your shared script contains enough documentation/instructions that other users are able to easily understand the purpose and are able to use it without a lot of guesswork.
30-
- **Stay clean**: Your code should be as clean, smart and understandable as possible. Prevent having any magic, encrypted or obfuscated code.
31-
32-
When *modifying existing scripts*, please read first:
33-
34-
- **Credits**: Please respect previous authors and leave them intact. If you feel you've done great enhancements to existing scripts, feel free to add yourself to the authors list.
35-
- **Compatibility**: Don't forget about backwards-compatibility. Try not to break existing scripts. If you're doing changes regarding parameters, dependencies or any other major changes, please create a new script directory or new files within the same folder.
36-
37-
Okay with the few points above? Great! Go ahead and create a pull request with your contribution. Thanks a lot! :-)
25+
Please check our [CONTRIBUTING.md](CONTRIBUTING.md) file for further information

0 commit comments

Comments
 (0)