Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update CONTRIBUTING.md #456

Merged
merged 1 commit into from
May 9, 2024
Merged

docs: update CONTRIBUTING.md #456

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 2 additions & 14 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Welcome, and thank you for your interest in contributing to _pygls_!

There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
There are many ways in which you can contribute, beyond writing code.

## Reporting Issues

Expand All @@ -28,31 +28,23 @@ File a single issue per problem and feature request. Do not enumerate multiple b
Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.

Please include the following with each issue:

* Reproducible steps (1... 2... 3...) that cause the issue

* What you expected to see, versus what you actually saw

* Images, animations, or a link to a video showing the issue occurring, if appropriate

* A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally

* **Note:** Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.

* If using VS Code, errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools)
* We follow [Convention Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages. For example, a commit should have a category and use lower case: `feat: solved the halthing problem`.

### Final Checklist

Please remember to do the following:

* [ ] Search the issue repository to ensure your report is a new issue

* [ ] Simplify your code around the issue to better isolate the problem

* [ ] If you are committing a PR, please update the [changelog] and [contributors] documents, as appropriate. For the [changelog], only _notable_ changes should be added following the _[Keep a Changelog][keepachangelog]_ format.

Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!

## Thank You
Expand All @@ -62,7 +54,3 @@ Your contributions to open source, large or small, make great projects like this
## Attribution

This _Contributing to pygls_ document is adapted from VS Code's _[Contributing to VS Code](https://github.com/Microsoft/vscode/blob/master/CONTRIBUTING.md)_.

[changelog]: https://github.com/openlawlibrary/pygls/blob/master/CHANGELOG.md
[contributors]: https://github.com/openlawlibrary/pygls/blob/master/CONTRIBUTORS.md
[keepachangelog]: https://keepachangelog.com/en/1.0.0/
Loading