-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Doc] Move contributing part into own file
- Loading branch information
Showing
2 changed files
with
17 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! :-) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters