-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from mills88812/altoids-pr-template
Adds a PR template and a short contributing explainer
- Loading branch information
Showing
2 changed files
with
32 additions
and
0 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 @@ | ||
 | ||
|
||
## Introduction | ||
The following is a general guide on how to help out for an open-source C# project like this, for those unfamiliar with typical etiquette and expectations. **These are not rules**, just some common wisdom that will make it easier for you to get your code merged and this mod further on its way to being complete! ❤️ | ||
|
||
## Basics | ||
- **Don't merge your own PR.** Unless it's important or beyond all reasonable doubt that you did it perfectly, wait for someone else to merge it. | ||
- **Try to ask for help when you don't understand something.** A lot of the info about the Rain World engine is not easily available online, but you may get a good answer if you just ask. Nobody is expected to know everything and nobody deserves wasting 10 hours on figuring something out all over again by themselves. *Don't be a Pebbles.* | ||
|
||
## Code Style | ||
There's no set style, but here's some recommendations: | ||
|
||
- Use file-wide namespaces instead of namespace blocks. This means writing `namespace Deadlands;` instead of `namespace Deadlands { /* ... all the code ... */ }`. | ||
- Never use `unsafe`. | ||
- Be communicative! Code you write is, in part, a conversation you are having with the rest of us. Explain yourself, use clear variable names, and keep it simple. |
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,17 @@ | ||
<!-- | ||
Thanks for making a PR! The following is a template demonstrating some things to mention in a PR submission. | ||
You don't need to follow this to the letter and may remove parts that are irrelevant to your PR. | ||
--> | ||
|
||
<!-- | ||
If possible & relevant, include a screenshot here that depicts what's new in the game, as it appears in your branch. | ||
--> | ||
|
||
## Summary | ||
<!-- Summarize what you did here. --> | ||
|
||
## Changelog | ||
<!-- | ||
Please have a bullet-point changelog of what is now different in the game, from the players' perspective. | ||
If there are changes that aren't user-facing, discuss them in the summary instead. | ||
--> |