Skip to content

docs: Update contribution guidelines to include LLM usage policies #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stv0g wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −2
Open

docs: Update contribution guidelines to include LLM usage policies #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/node/development/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contribution guidelines
# Contribution Guidelines

All contributions to VILLASframework are welcome! We are happy to receive your pull requests.

Expand All @@ -12,7 +12,19 @@ As the codebase and these guidelines evolve, the codebase may not always be in f
Existing code should not be taken as and example for new code.
PRs that update the style of existing code should be made separate from PRs that change or add code.

## VILLASframework Coding Guidelines
## LLM / AI Usage Guidelines

- AI / LLM usage does not need to be declared in commit messages via `Co-authored-by`.
- AI / LLM usage must be disclosed in the pull request description.
- The disclosure must include which tools were used and for which parts of the contribution (for example: drafting text, suggesting code changes, or generating tests).
- GitHub is where humans collaborate: pull request descriptions, comments, and issues must be written by and addressed to humans.
- Pull requests must be sized so a human can review them in one sitting.
- The submitter must understand the change well enough to explain and defend it during review.
- Review comments must be addressed properly; pull requests that cannot be reviewed by humans, or that ignore reviewer feedback, may be closed or rejected.
- Keep the DCO in mind: by signing off, you assert that you have the right to submit the contribution, regardless of how it was produced.


## Coding Guidelines

1. Automated formatting tools
1. **clang-format:** The VILLASframework uses clang-format to enforce a consistent code style. Please refer to the [clang-format configuration](https://github.com/VILLASframework/node/blob/master/.clang-format). Please run `clang-format` on your code before making a commit.
Expand Down
Loading