mtan93/Installomator
1
0
Fork 0
mirror of https://github.com/mtan93/Installomator.git synced 2026-03-08 05:31:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING.md

Browse Source
This commit is contained in:
Søren Theilgaard
2021-10-14 21:37:05 +02:00
parent 310140d64f
commit 43aa0a835c
2 changed files with 28 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,26 @@
# Contributing to Installomator
__Please note, that if you are contributing to this project with new labels or other suggestions in PRs, please put your changes in the fragmented files, not the full `Installomator.sh` script. The full script is now a build of the fragments, and will be overwritten.__
We try to keep the script as short as possible, and with more than 300 labels, we can save 300 lines in the script, if we do not have credit lines on each of these. So we are thankful for your contribution, but we will be removing these lines in the coming releases.
## Labels
If you need a new label, please take a look at the tutorials in the Wiki, if those can be helpful for starting out on the creation of the label.
We really encourage you to try out finding the version of the app online, so that `appNewVersion` can be filled in the label. It helps a lot when the software needs update, and greatly improve user experience.
When creating a new label, please file a pull request (PR). And feel free to ask questions or make your comments about what else is needed, if we should take a look at the label, or help out in finding the version or isolating URLs or anything else.
Please include the log of installing this label in the description.
Please have one label per PR, so we can separate these. Also if you change/fix a label.
Thank you very much!
## Issues
If you encounter an issue, please file this, and include the full log of what the bug is.
Do not use this for support, but use Slack, as described in [README.md](https://github.com/Installomator/Installomator/)

8
README.md
View File

@@ -16,13 +16,9 @@ I have put a lot of work into making it stable and safe, but I cannot - of cours
Discussion, support and advice around Installomator happens in the `#installomator` channel in the [MacAdmins.org Slack](https://macadmins.org). Go there for support questions.
Do not create an issue just when you have a questions, but do file an issue or pull request for bugs or wrong behavior. When in doubt, ask in the above Slack channel.
Do not create an issue just when you have a questions, but do file an issue or pull request (PR) for bugs or wrong behavior. When in doubt, ask in the above Slack channel.
If you have added a new label, then please file a pull request. (and Thank you!)
__Please note, that if you are contributing to this project with new labels or other suggestions in PRs, please put your changes in the fragmented files, not the full `Installomator.sh` script. The full script is now a build of the fragments, and will be overwritten.__
We try to keep the script as short as possible, and with more than 300 labels, we can save 300 lines in the script, if we do not have credit lines on each of these. So we are thankful for your contribution, but we will be removing these lines in the coming releases.
Please see [CONTRIBUTING.md](https://github.com/Installomator/Installomator/blob/dev/CONTRIBUTING.md) for how to contribute.
## More reading