Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
berry120 authored Dec 24, 2023
1 parent 4a97d7f commit 0d2bb52
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ It's also fantastic when someone contributes a new translation, and we gladly ac

It's always fantastic when new code contributors come on board! We generally accept bug fixes, so long as the commit comments are clear, the fixes clearly won't introduce any new issues (or at least have a very low probability of doing so), and the code is well written and clearly documented. In the case where any of these aren't the case, then we won't accept right away, but where possible we'll happily work with you to bring your contribution to the point where we can accept it.

We're usually a little more cagey about accepting pull requests for new features out of the blue - they're great to have, but we have to make sure that they're implemented well, not rushed, and the core team agrees on any UX implications they may have. If you're thinking of a new feature, then talk to us first (feel free to create an issue for it if one doesn't exist already.)
However, please be aware the bar is set far higher for pull requests for new features out of the blue - especially if these haven't been discussed and agreed with the core team in advance. **There's a good chance these could just be closed if we don't agree that the feature(s) being added are a priority.** New features may seem great to have, but we have to make sure that they're implemented well, not rushed, and the core team agrees on any UX implications they may have. If you're thinking of a new feature, then talk to us first (feel free to create an issue for it if one doesn't exist already.) Additional features also present an ongoing maintenance burden to the core contributors, as they'd have to be supported & maintained long after the original PR author may have disappeared.

In short, please **only submit a PR for a new feature if you're prepared for the good possibility that PR is rejected.**

Major refactorings of the project, or a significant part of it, are very unlikely to be accepted unless specifically discussed and agreed in advance. (This is usually something that we'd leave to the core developers though.)

Expand Down

0 comments on commit 0d2bb52

Please sign in to comment.