Repository navigation
docs: add contribution guidelines and pull request template #462
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.
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
Merged
nightt5879
merged 4 commits into
develop
from
nightt5879/community-contribution-guidelines
Aug 5, 2026
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
82e1f1e
docs: add contribution guidelines and pull request template
nightt5879 08d03de
docs: specify AI model in pull request example
nightt5879 82f272c
docs: use first-person AI validation wording
nightt5879 5669329
docs: link contribution guide from readmes
nightt5879 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| ## Summary | ||
|
|
||
| <!-- What changed, and why is it needed? --> | ||
|
|
||
| ## Related Issue | ||
|
|
||
| <!-- Example: Closes #123 --> | ||
|
|
||
| ## Validation | ||
|
|
||
| - [ ] Applicable checks pass: lint, format check, tests, and build | ||
| - [ ] Relevant E2E and manual tests are complete or not applicable | ||
|
|
||
| Evidence, screenshots, or compatibility notes: | ||
|
|
||
| <!-- Include screenshots for UI changes and `.drawnix` compatibility notes when relevant. --> | ||
|
|
||
| ## AI Assistance | ||
|
|
||
| Did you use AI tools to generate or substantially modify code, tests, or documentation in this pull request? | ||
|
|
||
| - [ ] No | ||
| - [ ] Yes | ||
|
|
||
| If yes: | ||
|
|
||
| - **Tool/model:** <!-- Example: Codex / GPT-5.6 Sol --> | ||
| - **AI-assisted work:** <!-- Affected files or tasks --> | ||
| - **My review and validation:** <!-- What did you personally review and test? --> | ||
|
|
||
| - [ ] I reviewed and understand the AI-assisted changes and can explain and maintain them | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] The title and description are in English, and the change is focused | ||
| - [ ] I reviewed and understand every submitted change | ||
| - [ ] Tests, documentation, and translations were updated when needed |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # Contributing to Drawnix | ||
|
|
||
| Thank you for contributing. Bug fixes, tests, documentation, translations, performance improvements, and focused features are welcome. | ||
|
|
||
| ## Community Language | ||
|
|
||
| Drawnix uses English for issues, pull requests, discussions, reviews, commit messages, and contributor documentation. Localized product content is welcome, but contribution discussions should remain in English. | ||
|
|
||
| ## Before You Start | ||
|
|
||
| - Search existing issues and discussions first. | ||
| - Reproduce bugs on the latest `develop` branch. | ||
| - Keep each issue or pull request focused on one problem. | ||
| - Discuss large features, architecture changes, or `.drawnix` format changes before implementation. | ||
| - Verify AI-assisted findings. Do not publish raw AI audit output or batches of unverified issues. | ||
|
|
||
| ## Local Development | ||
|
|
||
| Use the Node.js version in `.nvmrc`. | ||
|
|
||
| ```bash | ||
| npm ci | ||
| npm run start | ||
| ``` | ||
|
|
||
| Before opening a pull request, run the checks that apply to your change: | ||
|
|
||
| ```bash | ||
| npm run lint | ||
| npm run format:check | ||
| npm run test | ||
| npm run build | ||
| ``` | ||
|
|
||
| For interaction changes, install the Playwright browsers and run the E2E tests: | ||
|
|
||
| ```bash | ||
| npx playwright install | ||
| npx nx e2e web-e2e | ||
| ``` | ||
|
|
||
| ## Pull Requests | ||
|
|
||
| - Target the `develop` branch. | ||
| - Use an English title, description, and clear commit messages. | ||
| - Explain what changed and why; link the related issue when available. | ||
| - Add or update tests for behavior changes. | ||
| - Include screenshots or a recording for visible UI changes. | ||
| - Update documentation and translations when needed. | ||
| - Preserve compatibility with existing `.drawnix` files when changing import, export, clipboard, or serialization behavior. | ||
| - Avoid unrelated formatting, refactoring, or dependency changes. | ||
|
|
||
| ## AI-Assisted Contributions | ||
|
|
||
| AI tools are welcome, but contributors remain responsible for their work. If AI generated or substantially modified code, tests, or documentation, disclose: | ||
|
|
||
| - The tool and model, if known | ||
| - What the AI helped with | ||
| - Your human review and testing | ||
|
|
||
| You must understand, explain, and maintain the submitted changes. Raw or unverified AI output is not acceptable. Trivial autocomplete, spelling, and formatting assistance do not require disclosure. | ||
|
|
||
| Do not provide secrets, private vulnerability details, personal data, or unauthorized content to external AI services. | ||
|
|
||
| ## License | ||
|
|
||
| By contributing, you agree that your contribution will be licensed under the repository's MIT License. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.