mirror of https://github.com/apple/pkl-vscode.git
44 lines
1.5 KiB
Plaintext
44 lines
1.5 KiB
Plaintext
:uri-github-issue-pkl-vscode: https://github.com/apple/pkl-vscode/issues/new
|
||
:uri-seven-rules: https://cbea.ms/git-commit/#seven-rules
|
||
|
||
= Pkl VSCode Contributors Guide
|
||
|
||
Welcome to the Pkl community, and thank you for contributing!
|
||
This guide explains how to get involved.
|
||
|
||
* <<Licensing>>
|
||
* <<Issue Tracking>>
|
||
* <<Pull Requests>>
|
||
|
||
== Licensing
|
||
|
||
Pkl VSCode is released under the Apache 2.0 license.
|
||
This is why we require that, by submitting a pull request, you acknowledge that you have the right to license your contribution to Apple and the community, and agree that your contribution is licensed under the Apache 2.0 license.
|
||
|
||
== Issue Tracking
|
||
|
||
To file a bug or feature request, use {uri-github-issue-pkl-vscode}[GitHub].
|
||
Be sure to include the following information:
|
||
|
||
* Context
|
||
** What are/were you trying to achieve?
|
||
** What's the impact of this bug/feature?
|
||
|
||
== Pull Requests
|
||
|
||
When preparing a pull request, follow this checklist:
|
||
|
||
* Imitate the conventions of surrounding code.
|
||
* Follow the {uri-seven-rules}[seven rules] of great Git commit messages:
|
||
** Separate subject from body with a blank line.
|
||
** Limit the subject line to 50 characters.
|
||
** Capitalize the subject line.
|
||
** Do not end the subject line with a period.
|
||
** Use the imperative mood in the subject line.
|
||
** Wrap the body at 72 characters.
|
||
** Use the body to explain what and why vs. how.
|
||
|
||
== Maintainers
|
||
|
||
The project’s maintainers (those with write access to the upstream repository) are listed in link:MAINTAINERS.adoc[].
|