Skip to content
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

Jump to bottom

[ci-skip] [meta] Update Contributing.md to reflect new naming #337

Closed
wants to merge 4 commits into from
Closed

[ci-skip] [meta] Update Contributing.md to reflect new naming #337

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef7a819
[ci-skip] [meta] Update Contributing.md to reflect new naming
TwoLeggedCat May 16, 2021
387fd8b
Commits->patches
TwoLeggedCat May 16, 2021
3e348ff
More commits->patches
TwoLeggedCat May 16, 2021
12869b4
Update CONTRIBUTING.md
TwoLeggedCat May 16, 2021
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
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ This method has the benefit of being able to compile to test your change without


## PR Policy
We'll accept changes that make sense. You should be able to justify their existence, along with any maintenance costs that come with them. Remember, these changes will affect everyone who runs Paper, not just you and your server.
We'll accept changes that make sense. You should be able to justify their existence, along with any maintenance costs that come with them. Remember, these changes will affect everyone who runs Purpur, not just you and your server.
While we will fix minor formatting issues, you should stick to the guide below when making and submitting changes.

## Formatting
Expand Down Expand Up @@ -204,3 +204,13 @@ Again, notice that the field is always public, but the setter is always private.
```java
return this.world.purpurConfig.useInhabitedTime ? this.w : 0;
```

### Naming your Patches/PRs
We use a naming system with a similar concept to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).

Patches are prefixed with a type (`[feat]`, `[fix]`, `[meta]`, `[refactor]`, `[perf]`). The type should also appear in your PR title.

This lets us and users:
* know what type of PR it is
* know what the patches do at a glance
* categorize the patches