Skip to content

Create CONTRIBUTE.md #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Clpsplug wants to merge 1 commit into
base: base
Choose a base branch
from
Draft

Create CONTRIBUTE.md #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contribution Guide

Contributors are asked to adhere to the following for easier processing of their contributions.


## Reporting an issue

* First, search the issues for what you are trying to report.
* If you don't find any duplicate issues, use the issue template to report your issue;
when clicking "new issue", several options should appear (e.g., Bug report.)
* Try to fill as much information in the template.
* Keep the scope of an issue to one 'issue'. Avoid cramming multiple independent issues into one.

## Submitting a PR

* PR should have a linked issue. If there's none, consider making one first.
* Don't forget an [issue-closing keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) if you want to close the issue in question
* PR title must be a bite-size description of what your PR does. Do not leave it as the branch name.
* Tiny fixes like typo fixes should be squashed.
* As soon as you notice that your `base` branch gets out of date when you have a PR, please `git pull --rebase origin base`.
* PR branches should be deleted when the PR is merged/closed.

## Code style

* Install the EditorConfig plugin for your IDE/text editor.
* Member variable name conventions:
|Visibility|Case|Sample|
|:---------|:---|:---|
|private (pure C#)|`_lowerCamelCase`|`private int _someInteger`|
|private (Unity field)|`lowerCamelCase`|`[SerializeField] private int someInteger`|
|protected|`UpperCamelCase`|`protected int SomeInteger`|
|public|`UpperCamelCase`|`public int SomeInteger`|
* Unless absolutely needed, declare Unity fields as `private`/`protected`