diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0acc561..4bd886d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -29,6 +29,32 @@ thought of being the motivation for your change. Describe the modifications you've done. +## AI Usage + +- [ ] Generative AI was used in this contribution + +If checked, please provide an explanation on how AI was used in the development of this pull request: + +- Description: _Include a high level description of Gen AI utilization_ +- Type of assistance: + - [ ] Code generation + - [ ] Documentation + - [ ] Debugging + - [ ] Testing + - [ ] Refactoring + - [ ] Other: +- Scope of usage: _Which files, functions, or sections were AI-assisted_ +- AI System used: + - [ ] ChatGPT + - [ ] Claude + - [ ] Gemini + - [ ] GitHub Copilot +- Level of modification: + - [ ] As-is + - [ ] Modified + - [ ] Used as inspiration +- Prompts used: _Please list or explain prompts that were used to develop this contribution_ + ## Result What will change as a result of your pull request? Note that sometimes this @@ -36,12 +62,12 @@ section is unnecessary because it is self-explanatory based on the solution. Some important notes regarding the summary line: -* Describe what was done; not the result -* Use the active voice -* Use the present tense -* Capitalize properly -* Do not end in a period — this is a title/subject -* Prefix the subject with its scope +- Describe what was done; not the result +- Use the active voice +- Use the present tense +- Capitalize properly +- Do not end in a period — this is a title/subject +- Prefix the subject with its scope ## Test Plan diff --git a/.github/workflows/gitleaks.yml b/.github/workflows/gitleaks.yml index 1133b85..fa890f1 100644 --- a/.github/workflows/gitleaks.yml +++ b/.github/workflows/gitleaks.yml @@ -3,6 +3,9 @@ on: pull_request: push: +permissions: + contents: read + jobs: scan-for-secrets: name: Run gitleaks @@ -14,4 +17,4 @@ jobs: - name: Check for GitLeaks uses: gacts/gitleaks@v1 with: - config-path: .github/.gitleaks.toml \ No newline at end of file + config-path: .github/.gitleaks.toml diff --git a/.github/workflows/repoHygieneCheck.yml b/.github/workflows/repoHygieneCheck.yml index 043e706..dbc6164 100644 --- a/.github/workflows/repoHygieneCheck.yml +++ b/.github/workflows/repoHygieneCheck.yml @@ -49,6 +49,8 @@ jobs: {% raw %} if: needs.check-first-run.outputs.should_run == 'true' {% endraw %} + permissions: + contents: read uses: DSACMS/repo-scaffolder/.github/workflows/extendJSONFile.yml@main with: url_to_json: 'https://raw.githubusercontent.com/DSACMS/repo-scaffolder/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/repolinter.json' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8501e0d..6945d38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -385,6 +385,24 @@ We also welcome improvements to the project documentation or to the existing docs. Please file an [issue](https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues). --> +## AI Usage + +AI tools *(LLMs, coding assistants)* are welcome as part of your contribution workflow, but they don't change who's responsible for the code you submit. + +### Recommended uses + +- Gaining understanding of the existing code, or solution ideas of the issue +- Translating or proofreading your comments or PR descriptions while keep the wording as close as possible to what you originally wrote + +Whenever you use AI in any of these ways, disclose it explicitly in your PR description. + +### Not recommended uses + +- External AI tooling *(bots, agents)* directly interacting with the project, including creating issues, opening PRs, or commenting on GitHub +- Submitting AI generated code you can't explain line by line to a developer, or using AI output without fully understanding it or verifying it's the correct approach +- Submitting a PR where the effort you put in, such as writing a prompt, is less than the effort it would take a maintainer to review it. We can already write prompts or run automated tools ourselves and doing that directly is faster and more secure than reviewing a low effort PR. +- Using AI to increase the breadth of your contributions, such as spreading yourself across several projects at once. You provide more value by engaging deeply with one or two projects than shallowly with many. + ## Policies ### Open Source Policy diff --git a/README.md b/README.md index 2298f67..47015db 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,7 @@ A list of core team members responsible for the code and documentation in this r ## Repository Structure - -```plaintext -. -``` - + **{list directories and descriptions}**