Liela Rotschy
72 lines
3.5 KiB
Markdown
72 lines
3.5 KiB
Markdown
## Contributing
|
|
|
|
[fork]: https://github.com/github/actions-languageservices/fork
|
|
[pr]: https://github.com/github/actions-languageservices/compare
|
|
[code-of-conduct]: CODE_OF_CONDUCT.md
|
|
|
|
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
|
|
|
|
We accept pull requests for bug fixes and features where we've discussed the approach in an issue and given the go-ahead for a community member to work on it. We'd also love to hear about ideas for new features as issues.
|
|
|
|
We track issues on our project board [here](https://github.com/orgs/github/projects/9557/views/1).
|
|
|
|
Please do:
|
|
|
|
* Check existing issues to verify that the [bug][bug issues] or [feature request][feature request issues] has not already been submitted.
|
|
* Open an issue if things aren't working as expected.
|
|
* Open an issue to propose a significant change.
|
|
* Open a pull request to fix a bug.
|
|
* Open a pull request to fix documentation about a command.
|
|
* Open a pull request for any issue labelled [`help wanted`][hw] or [`good first issue`][gfi].
|
|
|
|
Please avoid:
|
|
|
|
* Opening pull requests for issues marked `needs-design`, `needs-investigation`, or `blocked`.
|
|
|
|
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
|
|
|
|
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
|
|
|
|
## Prerequisites for running and testing code
|
|
|
|
This repository contains multiple packages and uses [npm workspaces](https://docs.npmjs.com/cli/v9/using-npm/workspaces?v=true) to manage the dependencies between them.
|
|
|
|
These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.
|
|
|
|
1. Install [Node.js](https://nodejs.org/en/download/) for your platform (>= version 18). Ensure you also use a recent version of `npm` that supports workspaces (>= version 7).
|
|
1. Install the dependencies. From the repository root run:
|
|
```bash
|
|
$ npm i
|
|
```
|
|
|
|
|
|
|
|
## Submitting a pull request
|
|
|
|
1. [Fork][fork] and clone the repository
|
|
1. Configure and install the dependencies: `npm i`
|
|
1. Create a new branch: `git checkout -b my-branch-name`
|
|
1. Make your change, add tests, and make sure the tests and linter still pass
|
|
1. Push to your fork and [submit a pull request][pr]
|
|
|
|
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
|
|
|
- Format your code with [prettier](https://prettier.io/).
|
|
- Write tests.
|
|
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
|
|
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
|
|
|
Please also look at the `README.md` files for each package for additional notes on contributing.
|
|
|
|
## Resources
|
|
|
|
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
|
|
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
|
|
- [GitHub Help](https://help.github.com)
|
|
|
|
|
|
[bug issues]: https://github.com/actions/languageservices/labels/bug
|
|
[feature request issues]: https://github.com/actions/languageservices/labels/enhancement
|
|
[hw]: https://github.com/actions/languageservices/labels/help%20wanted
|
|
[gfi]: https://github.com/actions/languageservices/labels/good%20first%20issue
|