github/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2026-09-06 12:09:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

📚 Update CONTRIBUTING (#9418)

Browse Source
This commit is contained in:
Xaviju 2026-05-07 14:01:43 +02:00 committed by GitHub
parent df9cef1bb8
commit defeeab054
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 44 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
CONTRIBUTING.md
View File

@ -159,7 +159,7 @@ To save time on both sides, please avoid submitting PRs that:
### Good first issues ### Good first issues
We use the `easy fix` label to mark issues appropriate for newcomers. We use the `good first issue` label to mark issues appropriate for newcomers.
## Commit Guidelines ## Commit Guidelines
@ -175,26 +175,26 @@ Commit messages must follow this format:
### Commit types ### Commit types
| Emoji | Description | | Emoji | Description |
|-------|-------------| | ---------------------- | -------------------------- |
| :bug: | Bug fix | | :bug: | Bug fix |
| :sparkles: | Improvement or enhancement | | :sparkles: | Improvement or enhancement |
| :tada: | New feature | | :tada: | New feature |
| :recycle: | Refactor | | :recycle: | Refactor |
| :lipstick: | Cosmetic changes | | :lipstick: | Cosmetic changes |
| :ambulance: | Critical bug fix | | :ambulance: | Critical bug fix |
| :books: | Documentation | | :books: | Documentation |
| :construction: | Work in progress | | :construction: | Work in progress |
| :boom: | Breaking change | | :boom: | Breaking change |
| :wrench: | Configuration update | | :wrench: | Configuration update |
| :zap: | Performance improvement | | :zap: | Performance improvement |
| :whale: | Docker-related change | | :whale: | Docker-related change |
| :paperclip: | Other non-relevant changes | | :paperclip: | Other non-relevant changes |
| :arrow_up: | Dependency update | | :arrow_up: | Dependency update |
| :arrow_down: | Dependency downgrade | | :arrow_down: | Dependency downgrade |
| :fire: | Removal of code or files | | :fire: | Removal of code or files |
| :globe_with_meridians: | Add or update translations | | :globe_with_meridians: | Add or update translations |
| :rocket: | Epic or highlight | | :rocket: | Epic or highlight |
### Rules ### Rules
@ -231,6 +231,19 @@ We use [cljfmt](https://github.com/weavejester/cljfmt) for formatting and
./scripts/lint ./scripts/lint
``` ```
For frontend SCSS, we use `stylelint` for linting and
`Prettier` for formatting:
```bash
cd frontend
# Lint SCSS
pnpm run lint:scss (does not modify files)
# Fix SCSS formatting (modifies files in place)
pnpm run fmt:scss
```
Ideally, run these as git pre-commit hooks. Ideally, run these as git pre-commit hooks.
[Husky](https://typicode.github.io/husky/#/) is a convenient option for [Husky](https://typicode.github.io/husky/#/) is a convenient option for
setting this up. setting this up.
@ -260,23 +273,23 @@ By submitting code you agree to and can certify the following:
> By making a contribution to this project, I certify that: > By making a contribution to this project, I certify that:
> >
> (a) The contribution was created in whole or in part by me and I have the > (a) The contribution was created in whole or in part by me and I have the
> right to submit it under the open source license indicated in the file; or > right to submit it under the open source license indicated in the file; or
> >
> (b) The contribution is based upon previous work that, to the best of my > (b) The contribution is based upon previous work that, to the best of my
> knowledge, is covered under an appropriate open source license and I have > knowledge, is covered under an appropriate open source license and I have
> the right under that license to submit that work with modifications, > the right under that license to submit that work with modifications,
> whether created in whole or in part by me, under the same open source > whether created in whole or in part by me, under the same open source
> license (unless I am permitted to submit under a different license), as > license (unless I am permitted to submit under a different license), as
> indicated in the file; or > indicated in the file; or
> >
> (c) The contribution was provided directly to me by some other person who > (c) The contribution was provided directly to me by some other person who
> certified (a), (b) or (c) and I have not modified it. > certified (a), (b) or (c) and I have not modified it.
> >
> (d) I understand and agree that this project and the contribution are public > (d) I understand and agree that this project and the contribution are public
> and that a record of the contribution (including all personal information > and that a record of the contribution (including all personal information
> I submit with it, including my sign-off) is maintained indefinitely and > I submit with it, including my sign-off) is maintained indefinitely and
> may be redistributed consistent with this project or the open source > may be redistributed consistent with this project or the open source
> license(s) involved. > license(s) involved.
### Signed-off-by ### Signed-off-by