Skip to content

Commit f92642a

Browse files
authored
Update CONTRIBUTING.md (#1772)
1 parent 919f419 commit f92642a

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
Feel free to join and collaborate on our [Discord Server](https://discord.gg/vChUXVf9Em).
44

5-
> ⚠️ Please do not submit `localization` related pull requests at this time.
5+
> [!WARNING]
6+
> Please do not submit `localization` related pull requests at this time.
67
> Once we are ready to support more languages we will let you know with a guide on how to contribute here and on our [Discord Server](https://discord.gg/vChUXVf9Em).
78
89
## Fork & Clone CodeEdit
@@ -13,6 +14,10 @@ Tap the **"Fork"** button on the top of the site. After forking clone the forked
1314

1415
Find issues from the [Issues tab](https://github.com/CodeEditApp/CodeEdit/issues) or from the To Do column in our [project](https://github.com/orgs/CodeEditApp/projects/3). If you find an issue you want to work on, please indicate it in the issue and/or attach a draft PR once available. An admin or maintainer will then assign the Issue and/or PR to you.
1516

17+
> [!IMPORTANT]
18+
> Please make sure to first comment under an issue or ask a maintainer to assign you to the issue before working on it. This helps prevent multiple people from working on the same
19+
> thing, which could result in your work not being merged. Additionally, some issues might be reserved for those with more in-depth knowledge of the codebase.
20+
1621
## Getting Started
1722

1823
Please read the [Getting Started](https://github.com/CodeEditApp/CodeEdit/wiki/Getting-Started) guide in our wiki.
@@ -40,12 +45,14 @@ The `PR` should include following information:
4045

4146
Request a review from one of our admins @austincondiff, @lukepistrol, @MarcoCarnevali, @jasonplatts, @pkasila or maintainers @cstef, @linusS1, @RayZhao1998, @wdg.
4247

43-
Note: If it is your first PR, an admin will need to request a review for you.
48+
> [!TIP]
49+
> If it is your first PR, an admin will need to request a review for you.
4450
51+
> [!IMPORTANT]
4552
> Please resolve all `Violation` errors in Xcode (except: _TODO:_ warnings). Otherwise the swiftlint check on GitHub will fail.
4653
4754
Once you submit the `PR` GitHub will run a couple of actions which run tests and `SwiftLint` (this can take a couple of minutes). Should a test fail, it cannot be merged until tests succeed.
4855

4956
Make sure to resolve all merge-conflicts otherwise the `PR` cannot be merged.
50-
51-
> **Important**: make sure your code is well documented so others can interact with your code easily!
57+
> [!IMPORTANT]
58+
> Make sure your code is well documented so others can interact with your code easily!

0 commit comments

Comments
 (0)