Skip to content

Commit

Permalink
[Doc] Move contributing part into own file
Browse files Browse the repository at this point in the history
  • Loading branch information
eiabea committed Dec 20, 2024
1 parent f963499 commit 4202ca1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 14 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Contributing

### New scripts

- **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.
- **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.
- **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.
- **Stay clean**: Your code should be as clean, smart and understandable as possible. Prevent having any magic, encrypted or obfuscated code.

### Modifying existing scripts

- **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.
- **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.

Okay with the few points above? Great! Go ahead and create a pull request with your contribution. Thanks a lot! :-)
16 changes: 2 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,8 @@ In case...

... 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.

## Contributions
## Contributing

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

When *contributing new scripts*, please check the following first:

- **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.
- **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.
- **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.
- **Stay clean**: Your code should be as clean, smart and understandable as possible. Prevent having any magic, encrypted or obfuscated code.

When *modifying existing scripts*, please read first:

- **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.
- **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.

Okay with the few points above? Great! Go ahead and create a pull request with your contribution. Thanks a lot! :-)
Please check our [CONTRIBUTING.md](CONTRIBUTING.md) file for further information

0 comments on commit 4202ca1

Please sign in to comment.