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
+18-9
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,24 @@ If you are up to the challenge of contributing to Cyclops, this document will he
6
6
7
7
Please note we have a [code of conduct](./CODE_OF_CONDUCT.md); follow it in all your interactions with the project.
8
8
9
+
## How to contribute
10
+
11
+
- Pick an issue [here](https://github.com/cyclops-ui/cyclops/issues). If you have already contributed, we encourage you not to pick issues labeled with `good first issue` since those are useful to first-time contributors to onboard
12
+
- Let us know you would like to solve the issue by leaving a comment on the issue or reaching out to us on Discord or some other way
13
+
-[Fork the repository](https://github.com/cyclops-ui/cyclops/fork) and clone it locally
14
+
- Create a new branch
15
+
- Make your changes
16
+
- Create a pull request back to the upstream repository (_Please make sure that your PR is up-to-date with the latest changes in main_)
17
+
- Wait for a review and address any comments
18
+
19
+
> ⚠️ **_IMPORTANT_** ⚠️
20
+
>
21
+
> It is highly discouraged to pick multiple issues at once. Resolving one issue at a time allows more people to contribute to the project and helps maintainers review your code.
22
+
>
23
+
> If you want to pick another issue, let us know, and we will unassign you from your current issue and assign you to another.
24
+
>
25
+
> The only exception here is if multiple issues are related and you think it would be easier to resolve them in a single PR.
26
+
9
27
## The components that make Cyclops
10
28
11
29
Cyclops is a mono-repo that contains both the frontend (`UI`) and the backend (`controller`) of the platform, as well as the code for our website and documentation (`web`).
@@ -119,12 +137,3 @@ and running the app
119
137
```zsh
120
138
npm start
121
139
```
122
-
123
-
## How to contribute
124
-
125
-
- Pick an issue [here](https://github.com/cyclops-ui/cyclops/issues). If you have already contributed, we encourage you not to pick issues labeled with `good first issue` since those are useful to first-time contributors to onboard
126
-
-[Fork the repository](https://github.com/cyclops-ui/cyclops/fork) and clone it locally
127
-
- Create a new branch
128
-
- Make your changes
129
-
- Create a pull request back to the upstream repository (_Please make sure that your PR is up-to-date with the latest changes in main_)
0 commit comments