diff --git a/.github/workflows/pr-quality.yml b/.github/workflows/pr-quality.yml index 67b8938c..0eaa5b04 100644 --- a/.github/workflows/pr-quality.yml +++ b/.github/workflows/pr-quality.yml @@ -11,7 +11,8 @@ on: jobs: anti-slop: - runs-on: ubuntu-latest + runs-on: ubuntu-24.04 + name: Detects and automatically closes low-quality and AI slop PRs steps: - uses: peakoss/anti-slop@v0 with: @@ -23,9 +24,9 @@ jobs: require-linked-issue: true # List of terms blocked from appearing in the PR description blocked-terms: "MANGO" - # Minimum GitHub account age in days - min-account-age: 30 # Require all changed files to end with a newline character - final-newline: false + require-final-newline: false # PR does not allow maintainers to push to the source require-maintainer-can-modify: false + # Minimum number of profile signals the user must have to pass. Disabled. + min-profile-completeness: 0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..a9218c99 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contributing to DejaCode + +Thank you for your interest in contributing to AboutCode projects. +Please **read the following guidelines carefully before submitting a pull request**. + +## Pull request rules + +- **Attach your PR to an existing issue.** Discuss the approach and implementation + details in the issue first, before writing any code. Please note that if the issue + has already been assigned to someone else, you are welcome to comment on it, but it + would be best to contribute code in such a case only if you are invited to do so. + +- **You must fully understand your code changes** and be able to explain them + clearly. If you cannot walk a reviewer through your changes, the PR will not + be accepted. + +- **Write your own descriptions, comments, and documentation.** All written + content in a PR must be authored by a human. + +- **Disclose any AI usage.** If any part of your contribution was generated or + assisted by AI, you must disclose this and specify the tools used. + +- **Include tests.** Any code change or addition must be accompanied by proper + unit tests. Untested code will not be merged. + +**Any PR that violates these rules will be closed.** + +## Pull request tips + +To maximize your chances of a successful contribution: + +- **Keep changes focused.** Address only what the issue requires. Do not bundle + unrelated changes together. + +- **Be patient.** Do not solicit maintainers for a review. + +- **Remember:** project maintainers have no interest in reviewing code + generated by machines. + +- **Do not make structural changes** to the codebase such as adding type hints. + +## Ways to Contribute + +See https://dejacode.readthedocs.io/en/latest/contributing.html for more ways to +contribute. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 9f8bf81d..00000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,6 +0,0 @@ -======================== -Contributing to DejaCode -======================== - -Documented at https://dejacode.readthedocs.io/en/latest/contributing.html -or in docs/contributing.rst for details. diff --git a/README.rst b/README.rst index c7487ab9..bee274be 100644 --- a/README.rst +++ b/README.rst @@ -29,6 +29,12 @@ The DejaCode documentation also provides: - how to customize your own workflows and reports. - guidelines for contributing to code development. +Contributing +============ + +Thank you for your interest in contributing to AboutCode projects. +Please `read the following guidelines carefully `_ before getting started. + Build and tests status ======================