Skip to content

Commit 0b3936c

Browse files
authored
Add warning to contributing docs (#1417)
1 parent ca07c6c commit 0b3936c

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@
33
Thanks for your interest in contributing to Bracket. Contributions are greatly appreciated!
44

55
Please see the [contributing docs](https://docs.bracketapp.nl/docs/community/contributing/) for more information.
6+
7+
> [!IMPORTANT]
8+
>
9+
> Note: please open an issue first before creating non-trivial PRs.

docs/content/community/contributing.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Contributing
33
---
44

5+
import {Callout} from 'nextra/components'
6+
57
# Contributing
68

79
If you're using Bracket and would like to help support its development, that would be greatly
@@ -32,6 +34,25 @@ Rename the directory to the name of your locale, and start translating the `comm
3234
the directory. It might be useful to use an online tool (Google `translate json file`) to do the
3335
translation for you, and then carefully check and correct any mistakes.
3436

37+
## Code contributions
38+
39+
Code contributions are welcome! Please make sure to adhere to the following when submitting a pull
40+
request:
41+
42+
- Limit Pull Request (PR) size: Aim for small PRs (around 300 lines) that focus on a single,
43+
clear task. This makes them faster to review and more likely to be merged.
44+
- Write clear, descriptive titles.
45+
- Test your code changes thoroughly.
46+
47+
<Callout type="warning">
48+
Before making a pull request of something that's not trivial, please open an issue to discuss it
49+
first. Often there's a simpler way to achieve a certain goal or the scope of Bracket will be too
50+
large to maintain if every type of feature gets added.
51+
52+
Smaller changes like small bug fixes or documentation improvements can be made without opening
53+
an issue first.
54+
</Callout>
55+
3556
## Contributors
3657

3758
See [README](https://github.com/evroon/bracket).

0 commit comments

Comments
 (0)