Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
radumarias authored Dec 13, 2024
1 parent b6d8586 commit de64d45
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,18 @@ Unless you explicitly state otherwise, any Contribution intentionally submitted
defined in the Apache License shall be dual-licensed as above, without any additional terms or conditions.

1. Join [slack](https://bit.ly/3UU1oXi) and join `#dev-beginners` channel
2. Become familiar with docs and code by reading the [ramp-up](docs/readme/Ramp-up.md) guide
3. **Ask the owner of the repository to add your GitHub username to the repository** so that you can work on issues and
2. **Ask the owner of the repository to add your GitHub username to the repository** so that you can work on issues and
be able to create your own branches and not need to fork the repo

# Devs & QA automation (which steps apply)

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 that you'll be working on. You can
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)
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 are progressing
on them. If the task is not an issue yet, convert it to issue first**
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**
6. Make the changes in your branch
7. Add docs as they apply
8. Add tests, benchmarks, and examples for your changes, if applicable
Expand All @@ -38,3 +41,7 @@ defined in the Apache License shall be dual-licensed as above, without any addit
16. Respond to any comments
17. **DON'T MERGE THE PR YOURSELF. LEAVE THAT TO REPOSITORY OWNERS**
18. In the end, ideally, it will be merged into `main`

# QA manual

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

0 comments on commit de64d45

Please sign in to comment.