You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-4Lines changed: 11 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,8 @@
2
2
3
3
Feel free to join and collaborate on our [Discord Server](https://discord.gg/vChUXVf9Em).
4
4
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.
6
7
> 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).
7
8
8
9
## Fork & Clone CodeEdit
@@ -13,6 +14,10 @@ Tap the **"Fork"** button on the top of the site. After forking clone the forked
13
14
14
15
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.
15
16
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
+
16
21
## Getting Started
17
22
18
23
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:
40
45
41
46
Request a review from one of our admins @austincondiff, @lukepistrol, @MarcoCarnevali, @jasonplatts, @pkasila or maintainers @cstef, @linusS1, @RayZhao1998, @wdg.
42
47
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.
44
50
51
+
> [!IMPORTANT]
45
52
> Please resolve all `Violation` errors in Xcode (except: _TODO:_ warnings). Otherwise the swiftlint check on GitHub will fail.
46
53
47
54
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.
48
55
49
56
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