-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 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,35 @@ | ||
= Contributions | ||
|
||
Contributions are very welcome - code, docs, whatever they might be! If this is | ||
your first contribution to an Open Source project or you're a core maintainer | ||
of multiple projects, your time and interest in contributing is most welcome. | ||
|
||
If you're not sure where to get started, raise an issue in the project. | ||
|
||
Ideas may be discussed, purely on their merits and issues. Our Code of Conduct | ||
(CoC) is straightforward - it's important that contributors feel comfortable in | ||
discussion throughout the whole process. This project has a | ||
[CONTRIBUTING](CONTRIBUTING.md) guide. | ||
|
||
== More than 3 lines - talk to someone first | ||
|
||
If you're planning on making a change that's more than a 3 lines, please talk to someone first. This is so that you don't waste your time on something that might not be accepted. It's also a good way to get some feedback on your idea and make sure you're on the right track. | ||
|
||
== A PR should be one logical change | ||
|
||
Please try to keep your pull requests small and focused. It's almost impossible to review PRs that change lots of files for lots of different reasons. If you have a big change, it's probably best to break it down into smaller, more manageable chunks, otherwise it's likely to be rejected. | ||
|
||
== If you're not sure, ask! | ||
|
||
Don't be afraid to ask for advice before working on a | ||
contribution. If you're thinking about a bigger change, especially that might | ||
affect the core working or architecture, it's almost essential to talk and ask | ||
about what you're planning might affect things. Some of the larger future plans may not be | ||
documented well so it's difficult to understand how your change might affect | ||
the general direction and roadmap of this project without asking. | ||
|
||
The preferred way to communicate is probably via Discord or GitHub issues. | ||
|
||
== Mechanics of submitting a pull request | ||
|
||
When you are ready for a PR, please see the link:.github/PULL_REQUEST_TEMPLATE.md[pull request template]. |