Skip to content

Commit ea8acd7

Browse files
authored
🌱 update contributing docs (cyclops-ui#530)
1 parent f71c72a commit ea8acd7

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

CONTRIBUTING.md

+18-9
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,24 @@ If you are up to the challenge of contributing to Cyclops, this document will he
66

77
Please note we have a [code of conduct](./CODE_OF_CONDUCT.md); follow it in all your interactions with the project.
88

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+
927
## The components that make Cyclops
1028

1129
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
119137
```zsh
120138
npm start
121139
```
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_)
130-
- Wait for a review and address any comments

0 commit comments

Comments
 (0)