Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Radu Marias <[email protected]>
  • Loading branch information
radumarias authored Dec 17, 2024
1 parent eee96fb commit 99fa3e4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ defined in the Apache License shall be dual-licensed as above, without any addit

# Devs & QA automation (which steps apply)

3. Become familiar with docs and code by reading the [ramp-up](docs/readme/Ramp-up.md) guide
3. Become familiar with docs and code by reading the [ramp-up](../docs/readme/Ramp-up.md) guide
4. Pick an open issue or a task in the corresponding [project](https://github.com/users/radumarias/projects/1) for the
repo you'll work on. You can
see [good for first issues](https://github.com/radumarias/rencfs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
see [good for first issues](https://github.com/xorio/rencfs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
that you can pick from
5. **Assign the issues you are working on to you and move them to the corresponding status column as you progress
. If the task is not an issue yet, convert it to an issue first**
Expand All @@ -38,7 +38,7 @@ defined in the Apache License shall be dual-licensed as above, without any addit
14. Push your changes, and if there are any errors, fix them before you push them
15. Create a `PR` back to the `parent` repo targeting the `main` branch with the title as the GitHub issue title, including `#ID`. Also, include the link to the GitHub issue in the description, saying like `Fix for <link>` for bugs or `Implementation for <link>` for features and others
16. Request review from owners of the repository by adding them to the `Reviewers` field
17. After you create the PR, link it to the GH issue from the mid-right of the page, press the gear icon from the below image, select `radumarias/rencfs`, then write the issue number and select it. This will link the two, and when the PR is merged, it will close the issue too
17. After you create the PR, link it to the GH issue from the mid-right of the page, press the gear icon from the below image, select `xoriors/rencfs`, then write the issue number and select it. This will link the two, and when the PR is merged, it will close the issue too
![image](https://github.com/user-attachments/assets/5ac0313d-4175-44d1-8d1e-d18da773ab32)
18. In the project, move the item to `In Code Review`
19. Monitor the checks (GitHub actions runs) and fix the code if they are failing
Expand All @@ -48,4 +48,4 @@ defined in the Apache License shall be dual-licensed as above, without any addit

# QA manual

Please follow these [steps](docs/readme/Testing.md).
Please follow these [steps](../docs/readme/Testing.md).

0 comments on commit 99fa3e4

Please sign in to comment.