chore(repo): meet github community standards - #6
Merged
Merged
Conversation
|
Drop the Status, What it is, Packages and Documentation sections along with the CI badge, and state the pre-1.0 caveat in a single GitHub alert instead. Point the license credit at the GitHub profile.
The main ruleset required a Build check that no longer reports, so its required status checks are now Check and Test.
Cover every way to contribute, not just code: questions, bug reports, feature requests, first contributions, setup, commit rules, changesets, review expectations and releases.
Drop .github/PULL_REQUEST_TEMPLATE.md and the contributing guide's references to it.
- Fix the Contributing Guidelines link, which 404ed without blob/main - Ask bug reporters for Batik, React, StyleX and bundler versions instead of `vp env doctor`, which users of the package do not have - Use the @batik/ namespace in placeholders and widen both template descriptions beyond documented behavior and new components - Ask for a StyleX-ready reproduction and soften the closing warning - Add a documentation check to the feature request preflight - Drop the Devsantara contact link from the issue chooser
Report violations through GitHub private reports, and name the maintainers as the Community Moderators.
edwintantawi
changed the title
edwintantawi
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What this changes
Turns the scaffold into a repository outside contributors can actually use.
ci.yml— runs on every pull request:Check(vp check),Test(
vp test run --coverage) andCommit message, which lints the pull requesttitle with commitlint because it becomes the squashed commit subject on
main. The title is read through the environment, never interpolated intothe script.
CONTRIBUTING.md— written from scratch: ways to contribute, setupthrough
vp, commands, the commit convention, how changesets work here, thepull request and review flow, and releases.
CODE_OF_CONDUCT.md— Contributor Covenant 3.0.SECURITY.md— a private reporting path through GitHub securityadvisories.
questions go to Discussions and vulnerabilities go to a private advisory.
README.md— an early-development warning (nothing is published to npmyet, and the API is not stable), plus contributing, security and license
sections.
package.json— dropsbuild,dev,start,format*andlint*scripts that only wrapped
vpbuilt-ins or a recursive run.Also fixes
release.yml: itsPackstep ranvp run buildbefore packing.That step now runs
vp run -r pack, so each package's ownpacktask runsbefore
changesets/action/pack.How to check it
The checks on this pull request are the checks:
Check,TestandCommit message.Breaking changes
None. Nothing is published yet.
Repository settings changed alongside this
Not in the diff, applied directly:
main: pull request required, required status checks, linearhistory, no force pushes, no deletion, squash-only merges.
npmdeployment environment created. It requires maintainer approval andonly deploys from
main.release.ymlalready referenced it.