Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesread authored Jan 23, 2025
1 parent 6f6b5cd commit ca714db
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Contributions
# 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
Expand All @@ -9,17 +9,17 @@ 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.
[Code of Conduct](CODE_OF_CONDUCT.md).

== More than 3 lines - talk to someone first
## 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
## 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!
## 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
Expand All @@ -30,6 +30,6 @@ 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
## 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].
When you are ready for a PR, please see the [pull request template](.github/PULL_REQUEST_TEMPLATE.md).

0 comments on commit ca714db

Please sign in to comment.