Skip to content

Commit 5c899d2

Browse files
authored
Update CONTRIBUTING.md for agentic PRs
Signed-off-by: Vignesh Venkatasubramanian Vaidyanathan <62492557+VigneshVSV@users.noreply.github.com>
1 parent 477c3fc commit 5c899d2

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ All types of contributions are encouraged and valued.
2020
2121
If you want to tackle any issues, un-existing features, please do have a look at [good-first-issues](https://github.com/hololinked-dev/hololinked/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). Issues are separated by perceived level of difficulty (`beginner`, `intermediate`) and type of contribution (`bug`, `feature`, `documentation` etc.). If you wish to propose a feature or bugfix, they are totally welcome and we could discuss it on discord/email (links in README) before you start working on it.
2222

23+
Good first issues are meant for humans to practice coding, trying to understand the codebase, propose improvements or flaws while reviewing the codebase etc. Please refrain from automating PRs with low quality fixes. I can do most good first issues on my own without anybody's help, so introduce more machines here is not the point.
24+
2325
Partial contributions are also taken if its easier to continue working on it. In this case, you can submit your fork to merge into a separate branch, where someone else can develop it until it meets the required standards for release.
2426

2527
To start developing and complete the contribution, following steps may be followed:
@@ -31,7 +33,7 @@ To start developing and complete the contribution, following steps may be follow
3133
5. Unit/Integration tests are recommended to be added for any new feature or bug fix. These tests can be run with `python -m unittest` under the `tests` directory.
3234
6. The CI pipeline currently enforces codestyle checks and tests, therefore steps 4 & 5 must be completed before making a pull request.
3335
7. Once you are done with your changes, make a pull request to the main repository. Your changes will be reviewed in detail and any review comments that may be added need to be resolved as well. When requirements are met and the pipeline passes, commits will be squashed and merged to the main branch.
34-
8. For AI generated code, please make sure to review it properly. You need to understand the code that you write or submit. Same applies to documentation, comments etc., please write them only to the extent you would be willing to read them later, not to bloat them with autogenerated text. A thumb rule is, if you cannot review your own generated code, I am not going to do it either. Submit only what you will review.
36+
8. For AI generated code, please make sure to review it properly. You need to understand the code that you write or submit. Same applies to documentation, comments etc., please write them only to the extent you would be willing to read them later, not to bloat them with autogenerated text. A thumb rule is, if you cannot review your own generated code, I am not going to do it either. Submit only what you will review.
3537

3638
There are also other repositories which can use your skills:
3739

0 commit comments

Comments
 (0)