mirror of
https://github.com/parkervcp/eggs.git
synced 2024-11-23 13:13:00 +08:00
Merge pull request #2105 from parkervcp/update_contribution_docs
update contribution and pr docs
This commit is contained in:
commit
0fcc581866
11
.github/pull_request_template.md
vendored
11
.github/pull_request_template.md
vendored
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## Checklist for all submissions
|
## Checklist for all submissions
|
||||||
|
|
||||||
<!-- insert X into the brackets to mark it as done. You can click preview to make the links appear clickable. -->
|
<!-- insert X into the brackets to mark it as done (i.e. [x]). You can click preview to make the links appear clickable. -->
|
||||||
|
|
||||||
* [ ] Have you followed the guidelines in our [Contributing document](https://github.com/parkervcp/eggs/blob/master/CONTRIBUTING.md)?
|
* [ ] Have you followed the guidelines in our [Contributing document](https://github.com/parkervcp/eggs/blob/master/CONTRIBUTING.md)?
|
||||||
* [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
|
* [ ] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
|
||||||
@ -12,6 +12,12 @@
|
|||||||
* [ ] Did you branch your changes and PR from that branch and not from your master branch?
|
* [ ] Did you branch your changes and PR from that branch and not from your master branch?
|
||||||
* If not, why?:
|
* If not, why?:
|
||||||
|
|
||||||
|
<!-- If this is an egg update fill these out -->
|
||||||
|
|
||||||
|
* [ ] You verify that the start command applied does not use a shell script
|
||||||
|
* [ ] If some script is needed then it is part of a current yolk or a PR to add one
|
||||||
|
* [ ] The egg was exported from the panel
|
||||||
|
|
||||||
<!-- You can erase the new egg submission template if you're not adding a completely new egg -->
|
<!-- You can erase the new egg submission template if you're not adding a completely new egg -->
|
||||||
|
|
||||||
## New egg Submissions
|
## New egg Submissions
|
||||||
@ -22,3 +28,6 @@
|
|||||||
* [ ] Did you PR the necessary changes to make it work?
|
* [ ] Did you PR the necessary changes to make it work?
|
||||||
3. [ ] Have you added the egg to the main README.md and any other README files in subdirectories of the egg (e.g /game_eggs) according to the alphabetical order?
|
3. [ ] Have you added the egg to the main README.md and any other README files in subdirectories of the egg (e.g /game_eggs) according to the alphabetical order?
|
||||||
4. [ ] Have you added a unique README.md for the egg you are adding according to the alphabetical order?
|
4. [ ] Have you added a unique README.md for the egg you are adding according to the alphabetical order?
|
||||||
|
5. [ ] You verify that the start command applied does not use a shell script
|
||||||
|
* [ ] If some script is needed then it is part of a current yolk or a PR to add one
|
||||||
|
6. [ ] The egg was exported from the panel
|
@ -4,17 +4,25 @@ You can contribute by either creating a new pull request or testing [existing pu
|
|||||||
|
|
||||||
## General rules for eggs
|
## General rules for eggs
|
||||||
|
|
||||||
1. Keep it simple.
|
1. Don't be afraid to submit PR's to the egg repo.
|
||||||
|
I don't bite. I will work with you on the egg and the required things to run it. Feel free to open a draft PR if you don't quite have the egg finished yet by yourself.
|
||||||
|
|
||||||
|
2. Keep it secure.
|
||||||
|
No start scripts that a user can edit.
|
||||||
|
If a start script is needed it should be part of a yolk.
|
||||||
|
|
||||||
|
3. Keep it simple.
|
||||||
We don't need 8 miles of the install script.
|
We don't need 8 miles of the install script.
|
||||||
|
|
||||||
2. Keep it small.
|
4. Keep it small.
|
||||||
Only use what is absolutely needed. The [Yolks install images](https://github.com/parkervcp/yolks#installation-images) already contain the most basic packages that speeds up the installation process.
|
Only use what is absolutely needed. The [yolks install images](https://github.com/parkervcp/yolks#installation-images) already contain the most basic packages that speeds up the installation process.
|
||||||
|
|
||||||
3. Use the stock images.
|
5. Use the stock images.
|
||||||
If you need something in an image, open a PR in [my yolks repo](https://github.com/parkervcp/yolks) where it can be reviewed and built. Self-hosted or third-party images won't be accepted for security reasons.
|
If you need something in an image, open a PR in [my yolks repo](https://github.com/parkervcp/yolks) where it can be reviewed and built. Self-hosted or third-party images won't be accepted for security reasons.
|
||||||
|
|
||||||
4. Don't be afraid to submit PR's to the egg repo.
|
6. Export eggs from the panel
|
||||||
I don't bite. I will work with you on the egg and the required things to run it. Feel free to open a draft PR if you don't quite have the egg finished yet by yourself.
|
We ask that you use the panel to manage and export eggs.
|
||||||
|
This keeps the egg format correctly
|
||||||
|
|
||||||
### Sources for working on a new egg
|
### Sources for working on a new egg
|
||||||
|
|
||||||
@ -52,9 +60,9 @@ The Pterodactyl install process is fairly simple once you know it.
|
|||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
Make sure your install process is rock solid as I will be testing eggs before they ever hit my repo.
|
Make sure your install process is rock solid as eggs will be tested before they are merged.
|
||||||
|
|
||||||
I will make suggestions and changes at will.
|
Suggestions and changes will be made at will.
|
||||||
This is to maintain a clean repo that others can pull and be fully aware of what is being done.
|
This is to maintain a clean repo that others can pull and be fully aware of what is being done.
|
||||||
|
|
||||||
## Step 3
|
## Step 3
|
||||||
|
Loading…
Reference in New Issue
Block a user