Skip to content

Commit 39bf204

Browse files
authored
update links and references in CONTRIBUTING.md (#2411)
* update contributing.md file * fix after review
1 parent cd8077c commit 39bf204

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ but it should be easily transferable to other (sub)projects.
4040

4141
> **Note:** Please don't file an issue to ask a question. You'll get faster results by using the resources below.
4242
43-
For general questions, please refer to [OpenCloud's FAQs](https://opencloud.eu/faq/) or check the [project page](https://github.com/opencloud-eu) for communication channels.
43+
For general questions, please refer to [OpenCloud's FAQs](https://docs.opencloud.eu/docs/admin/resources/faq/) or check the [project page](https://github.com/opencloud-eu) for communication channels.
4444

4545
## What to know before getting started
4646

@@ -55,7 +55,7 @@ The OpenCloud project follows the strict GitHub workflow of development as brief
5555
### OpenCloud Company, Engineering Partners and Community
5656

5757
OpenCloud is largely created by developers who are employed by the [OpenCloud company](https://opencloud.eu), which is located in Germany.
58-
It is providing support for OpenCloud for customers mainly in the EU. In addition, there are engineering partners who also work full-time on OpenCloud related code, for example, on the component [REVA](https://github.com/cs3org/reva/).
58+
It is providing support for OpenCloud for customers mainly in the EU. In addition, there are engineering partners who also work full-time on OpenCloud related code, for example, on the component [REVA](https://github.com/opencloud-eu/reva/).
5959

6060
Because of that fact, the pace that the development is moving forward is sometimes high for people who are not willing and/or able to spend a comparable amount of time to contribute.
6161
Even though this can be a challenge, it should not scare anybody away. Here is our clear commitment that we feel honored by everybody who is interested in our work and improves it, no matter how big the contribution might be.
@@ -113,7 +113,7 @@ Explain the problem and include additional details to help maintainers reproduce
113113
Provide more context by answering these questions:
114114

115115
* **Did the problem start happening recently** (e.g. after updating to a new version) or was this always a problem?
116-
* If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen? You can find more information about how to set up [test environments](https://docs.opencloud.eu/devel/testing) in the [developer documentation](https://docs.opencloud.eu/docs/dev/intro).
116+
* If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen? You can find more information about how to set up in the [Getting Started guide](https://docs.opencloud.eu/docs/admin/getting-started).
117117
* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
118118

119119
Include details about your configuration and environment as asked for in the template.
@@ -146,15 +146,13 @@ Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com
146146

147147
Unsure where to begin contributing to OpenCloud? You can start by looking through these `Needs-help` issues:
148148

149-
* The [Good first issue](https://github.com/opencloud-eu/opencloud/labels/Topic%3Agood-first-issue) label marks good items to start with.
150-
* [Tests needed](https://github.com/opencloud-eu/opencloud/labels/Interaction%3ANeeds-tests) - issues which would benefit from a test.
151-
* [Help wanted issues](https://github.com/opencloud-eu/opencloud/labels/Interaction%3ANeeds-help) - issues which should be a bit more involved.
149+
* The [Good first issue](https://github.com/opencloud-eu/opencloud/labels/Type%3Agood-first-issue) label marks good items to start with.
150+
* The [Feature Request](https://github.com/opencloud-eu/opencloud/issues?q=state%3Aopen%20label%3AType%3AFeature-Request) label lists features the community would like to see implemented.
152151

153152
It is fine to pick one of the lists following personal preference.
154153
While not perfect, the number of comments is a reasonable proxy for the impact a given change will have.
155154

156-
To find out how to set up OpenCloud for local development, please refer to the [Developer Documentation](https://docs.opencloud.eu/docs/dev/web/getting-started).
157-
It contains a lot of information that will come in handy when starting to work on the project.
155+
To find out how to set up OpenCloud for local development, please refer to the [Developer Documentation](https://docs.opencloud.eu/docs/dev/web/getting-started) for the web side, and the general server [README](https://github.com/opencloud-eu/opencloud/blob/main/README.md) for backend setup. Both contain information that will come in handy when starting to work on the project.
158156

159157
### Pull Requests
160158

@@ -221,7 +219,7 @@ To help you find issues and pull requests, each label can be used in search link
221219
The labels are loosely grouped by their purpose, but it's not required that every issue has a label from every group or that an issue can't have more than one label from the same group.
222220

223221
The list here contains all the more general categories of issues which are followed by a colon and a specific value.
224-
For example, severity 1 looks like `Severity:sev1-critical`.
222+
For example, severity 1 looks like `Priority:p1-urgent`.
225223

226224
#### Platform
227225

@@ -257,7 +255,7 @@ Categorizes the issue to also indicate the type of the issue.
257255

258256
#### Status
259257

260-
The status in the ticket life cycle. Keep an eye on that one, especially for the `Waiting-for-Feedback` tag which might indicate that the reporter is asked for feedback.
258+
The status in the ticket life cycle. Keep an eye on that one, especially for the `Status:Needs-Review` tag which might indicate that the reporter is asked for feedback.
261259

262260
#### Interaction
263261

0 commit comments

Comments
 (0)