Meta: Add CONTRIBUTING.md and lint-commit.sh helper script #164
Conversation
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
ADKaster
commented
Jul 15, 2025
|
|
||
| jobs: | ||
| lint: | ||
| runs-on: blacksmith-2vcpu-ubuntu-2404 |
There was a problem hiding this comment.
Are these available org-wide? or do they need enabled per-repo
| if: ${{ failure() && !github.event.pull_request.draft }} | ||
| uses: IdanHo/comment-on-pr@63ea2bf352997c66e524b8b5be7a79163fb3a88a | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.LADYBIRD_BOT_TOKEN }} |
There was a problem hiding this comment.
same Q for the bot token. org-wide, or needs owner fiddling in the settings?
CONTRIBUTING.md
Outdated
Comment on lines
65
to
68
| * Examples: `LibMedia`, `WebContent`, `CI`, `AK`, `RequestServer`, `js` | ||
| * Don't use a category like "`Libraries`" or "`Utilities`", except for generic changes that affect a large portion of code within these directories. | ||
| * Don't use specific component names, e.g. C++ class names, as the category either - mention them in the summary instead. E.g. `LibGUI: Brief description of what's being changed in FooWidget` rather than `FooWidget: Brief description of what's being changed` | ||
| * Several categories may be combined with `+`, e.g. `LibJS+LibWeb+Browser: ...` |
There was a problem hiding this comment.
I deleted most of the C++-isms from this section, but kept this because thinking of new website-specific component examples didn't sound like fun.
|
|
||
| Ping them right away if it's something urgent! If it's less urgent, advertise your PR on Discord (`#code-review`) and ask if someone could review it. | ||
|
|
||
| ### Is Discord the place to ask for review help, or is GitHub preferred? |
There was a problem hiding this comment.
the note on stalebot was deleted here, but can be added back if we turn it on for this repo.
The contributing docs are lightly edited from the original file in the ladybird repo. The script is a straight copy paste.
This is a straight copy from the ladybird repo, with a single docs link changed in the bot message.
ADKaster
force-pushed
the
contributing-guidelinez
branch
from
49c804f to
fb3de79
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The contributing docs are lightly edited from the original file in the
ladybird repo. The script is a straight copy paste.