Skip to content

Commit 5335f88

Browse files
mdwigleymdwigley
committed
#1 Adding templates, license and contributing documentation
1 parent 51312bd commit 5335f88

10 files changed

+279
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at md.wigley@hotmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
<!--- Ensure you are in the proper repository for the bug report.-->
8+
<!--- Please add the "bug" label found to the right -->
9+
<!--- Provide a general summary of the bug in the Title above -->
10+
11+
## Description
12+
<!--- Provide a more detailed introduction to the issue itself, and why you consider it to be a bug -->
13+
14+
## Expected Behavior
15+
<!--- Tell us what should happen -->
16+
17+
## Actual Behavior
18+
<!--- Tell us what happens instead -->
19+
20+
## Steps to Reproduce
21+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
22+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
23+
1.
24+
2.
25+
3.
26+
4.
27+
28+
## Context
29+
<!--- How has this bug affected you? What were you trying to accomplish? -->
30+
31+
## Possible Fix
32+
<!--- Not obligatory, but suggest a fix or reason for the bug -->
33+
34+
## Your Environment
35+
<!--- Include as many relevant details about the environment you experienced the bug in -->
36+
* Version used:
37+
* Operating System and version (desktop or mobile):

‎.github/ISSUE_TEMPLATE/Custom.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Support question
3+
about: Ask a support question
4+
5+
---
6+
7+
<!--- Ensure you are in the proper repository for the question.-->
8+
<!--- Please add the "question" label found to the right -->
9+
<!--- Provide a general summary of the question in the Title above -->
10+

‎.github/ISSUE_TEMPLATE/Feature_request.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
<!--- Ensure you are in the proper repository for the feature request.-->
8+
<!--- Please add the "enhancement" label found to the right -->
9+
<!--- Provide a general summary of the request in the Title above -->
10+
11+
## Detailed Description
12+
<!--- Provide a detailed description of the change or addition you are proposing -->
13+
14+
## Context
15+
<!--- Why is this change important to you? How would you use it? -->
16+
<!--- How can it benefit other users? -->
17+
18+
## Possible Implementation
19+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
20+
21+
## Related Issues
22+
<!--- If this feature requires new or changed game assets then add the asset request issue link here -->
23+
24+
## Target Platform(s)
25+
<!--- If this feature request is for a specific platform or set of platforms then list them here -->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
6+
## Related Issue
7+
<!--- This project only accepts pull requests related to open issues -->
8+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
9+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
10+
<!--- Please link to the issue, asset and/or documentation issues here: -->
11+
12+
## Motivation and Context
13+
<!--- Why is this change required? What problem does it solve? -->
14+
15+
## How Has This Been Tested?
16+
<!--- Please describe in detail how you tested your changes. -->
17+
<!--- Include details of your testing environment, and the tests you ran to -->
18+
<!--- see how your change affects other areas of the code, etc. -->
19+
20+
## Screen-shots (if appropriate):
21+
22+
23+
## Types of changes
24+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
25+
- [ ] Bug fix (non-breaking change which fixes an issue)
26+
- [ ] New feature (non-breaking change which adds functionality)
27+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
28+
29+
## Checklist:
30+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
31+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
32+
- [ ] I have read the **CONTRIBUTING** document.
33+
- [ ] My change requires a change to the game logic.
34+
- [ ] I have linked the project issue above.
35+
- [ ] My change requires a change to the assets.
36+
- [ ] I have linked the asset issue above.
37+
- [ ] My change requires a change to the documentation.
38+
- [ ] I have linked the documentation issue above.

‎CONTRIBUTING.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Quick Start<a id="quick-start"></a>
2+
* [How to Open a Bug Report](#how-to-open-a-bug-report)
3+
* [How to Open a Feature Request](#how-to-open-a-feature-request)
4+
* [How to Open a Documentation Request](#how-to-open-a-documentation-request)
5+
* [How to Submit Code](#how-to-submit-code)
6+
7+
## How to Open a Bug Report<a id="how-to-submit-a-bug-report"></a>
8+
1. Determine if the bug has already been [reported](https://github.com/mdwigley/PrefabLightmapping/issues?q=label%3Abug+is%3Aopen+is%3Aall)
9+
* If you find that the Issue has already been opened then a new Issue is not needed.
10+
* Feel free to add your experiences to bug reports and to reopen bug Issues if it crops up again.
11+
2. Create a "Bug Report" on the [Issues page](https://github.com/mdwigley/PrefabLightmapping/issues/new?template=Bug_report.md).
12+
* Add [BUG] to the title of your issue _(ie [BUG] Cats Get Too Many Cheeseburgers)_
13+
* Make sure that you are very detailed with what you are experiencing
14+
3. Check back often, or enable the notification options, in case others have questions or need further clarification
15+
16+
## When is it a Feature Request
17+
It might be a little nuanced the difference between a bug vs a change in the expected operation of the game. In the case of the latter we would want to open a feature request. The following is a few examples of what would constitute a Feature Request:
18+
* The element is completely missing from the project
19+
* Current behavior is missing a critical element to make it complete
20+
* A current element behaves in a way you feel is detrimental to the project as a whole but is the current, expected, behavior
21+
22+
When you have the next best feature for the PrefabLightmapping project you will first need to let us know about it!
23+
24+
## How to Open a Feature Request<a id="how-to-open-a-feature-request"></a>
25+
1. Determine if the same or similar [Feature Requests](https://github.com/mdwigley/PrefabLightmapping/issues?q=label%3Aenhancement+is%3Aopen+-label%3Adocumentation) already exists.
26+
* If one does exist, feel free to expand upon it by commenting on the Issue but **do not open a new one**.
27+
2. Create a [Feature Request](https://github.com/mdwigley/PrefabLightmapping/issues/new?template=Feature_request.md) on the Issues page.
28+
* If your Feature Request requires additional/changed documentation then a [Documentation Request](#how-to-open-a-documentation-request) is also required
29+
* You must provide a reference to the Documentation Request in the Feature Request Issue
30+
* Make sure that you are very detailed with what you think the feature should accomplish, how it should be implemented and it's predicted effect on other features.
31+
3. Check back often, or enable the notification options, in the event others have questions about your proposal
32+
4. You will know when the feature is accepted when the "approved" label is assigned to it
33+
* If there are multiple requests as a part of the feature, the feature will not be moved to the master branch until all dependent parts have been completed.
34+
* It is important to keep in mind that all new features, even simple changes, often have wide ranging effect which need to be fully explored.
35+
* Also remember that not all features can be added into the game (but I'm sure we'll try!) and features need to be released in an orderly way so even if the feature is accepted it may not go in immediately.
36+
37+
## How to Open a Documentation Request<a id="how-to-open-a-documentation-request"></a>
38+
1. Determine if the [Documentation Request](https://github.com/mdwigley/PrefabLightmapping/issues?q=label%3Aenhancement,documentation+is%3Aopen) you want to create already exists.
39+
* Ask questions about implementation on the Issue thread and/or join the [Discord](https://discord.com/invite/mWDHDqkzeR) server to talk with people in real time.
40+
* If you find an Issue that is very close to what you'd like to do but missing some critical element, comment on that Issue so the change can be discussed.
41+
2. Open an [Issue](https://github.com/mdwigley/PrefabLightmapping/issues/new?template=Feature_request.md) explaining your proposed documentation changes/additions
42+
* Add [DOC] the title of your issue _(ie. [DOC] How to Install PrefabLightmapping)_
43+
3. Others may ask questions or request changes to your proposal so make sure to check back, or enable the notification options!
44+
4. You will know if the Issue is accepted when it's given the "approved" label
45+
* If there are multiple requests as a part of the request, the request will not be moved to the master branch until all dependent parts have been completed.
46+
47+
## How to Submit Documentation<a id="how-to-submit-documentation"></a>
48+
1. [Find an Issue](#how-to-find-documentation-tasks) to resolve
49+
2. [Fork](https://help.github.com/articles/fork-a-repo/) the [repository](https://github.com/mdwigley/PrefabLightmapping/)
50+
3. [Create a new branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) with the format 'issue#{issue-id}-{your-github-user}' _(ie issue#224-mdwigley)_
51+
4. Make any changes or additions to your new branch
52+
* Make sure to [keep your forks in sync](https://help.github.com/articles/syncing-a-fork/) with the original repository
53+
* If you find that you need help with implementation, ask to have the "Help Wanted" label added to the issue as well as seeking others on the [Discord](https://discord.com/invite/mWDHDqkzeR) server
54+
5. When finished, submit a [Pull Request](https://help.github.com/articles/about-pull-requests/) that includes just the changes in the Issue.
55+
* Others may ask questions or request changes so make sure to check back, or enable the notification options!
56+
6. The [Pull Request](https://help.github.com/articles/about-pull-requests/) will be reviewed and, if approved, will be merged.
57+
* If there is an Asset or Project Issue in conjunction with the Documentation Issue, the feature will not be moved to the master branch until all dependent parts have been completed.
58+
* When merged you will be an official contributor.
59+
60+
## How to Submit Code<a id="how-to-submit-code"></a>
61+
1. Setup your [Development Environment](/docs//Dev.Env.Win10.md)
62+
2. [Find an issue](#how-to-find-programing-tasks) to resolve
63+
3. [Fork](https://help.github.com/articles/fork-a-repo/) the [repository](https://github.com/mdwigley/PrefabLightmapping/)
64+
4. [Create a new branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) with the format 'issue#{issue-id}-{your-github-user}' _(ie issue#224-mdwigley)_
65+
5. [Update](https://gist.github.com/gitaarik/8735255#keeping-your-submodules-up-to-date) sub-modules
66+
6. Make any changes or additions to your new branch (**do not** modify "./Assets/Internal")
67+
* Make sure to [keep your forks in sync](https://help.github.com/articles/syncing-a-fork/) with the original repository
68+
* If you find that you need help with implementation, ask to have the "Help Wanted" label added to the issue as well as seeking others on the [Discord](https://discord.com/invite/mWDHDqkzeR) server
69+
* Ensure all files have been white-space formatted
70+
* Often the default formatting for Visual Studio or MonoDevelop will do
71+
* If you use Visual Studio you can use the [official format settings](/docs/assets/files/CONTRIBUTING/.editorconfig)
72+
* Comment your code with both code level and construct definitions
73+
* We use Doxygen for code level documentation
74+
7. When finished, submit a [Pull Request](https://help.github.com/articles/about-pull-requests/) that includes just the changes in the Issue.
75+
* Others may ask questions or request changes so make sure to check back, or enable the notification options!
76+
8. The [Pull Request](https://help.github.com/articles/about-pull-requests/) will be reviewed and, if approved, will be merged.
77+
* If there is an Asset or Documentation Issue in conjunction with the Project Issue, the feature will not be moved to the master branch until all dependent parts have been completed.
78+
* When merged you will be an official contributor!
79+
80+
# Attribution
81+
This CONTRIBUTING document was compiled with the help of [nayafia/contributing-template](https://github.com/nayafia/contributing-template/blob/master/CONTRIBUTING-template.md).

‎CONTRIBUTING.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Enterlucent
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎LICENSE.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎README.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)