-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: update contribution guidelines (#2913)
- Loading branch information
Showing
4 changed files
with
59 additions
and
40 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Bug report | ||
about: Create an issue to fix a bug | ||
labels: ["bug"] | ||
--- | ||
|
||
<!-- | ||
BEFORE SUBMITTING: Please search in the existing issues to make sure this issue hasn't been reported already | ||
--> | ||
|
||
## Bug description | ||
|
||
|
||
## Environment | ||
- Browser: Chrome | ||
|
||
## Minimal code snippet | ||
|
||
|
||
## Expected result | ||
|
||
|
||
## Obtained result | ||
|
||
|
||
## Screenshots |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,15 @@ | ||
# Hey, thank you for contributing to wavesurfer.js! | ||
## Short description | ||
Resolves # | ||
|
||
To review/merge open PRs it is very helpful to know as much as possible about the changes which are being introduced. Reviewing PRs is very time consuming, please be patient, it can take some time to do properly. | ||
## Implementation details | ||
|
||
**Title:** Please make sure the name of your PR is as descriptive as possible (Describe the feature that is introduced or the bug that is being fixed). | ||
|
||
## Please make sure you provide the information below: | ||
## How to test it | ||
|
||
### Short description of changes: | ||
|
||
## Screenshots | ||
|
||
### Breaking in the external API: | ||
|
||
|
||
### Breaking changes in the internal API: | ||
|
||
|
||
### Todos/Notes: | ||
|
||
|
||
### Related Issues and other PRs: | ||
## Checklist | ||
* [ ] This PR is covered by e2e tests | ||
* [ ] It introduces no breaking API changes |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# CONTRIBUTING to wavesurfer.js | ||
|
||
Hello there, | ||
|
||
Firstly, a heartfelt thank you! We sincerely appreciate your interest in wavesurfer.js and are really excited to see your contributions to our community. | ||
|
||
Here are a few guidelines to keep in mind when you're ready to contribute: | ||
|
||
## 1. Search in Existing Issues | ||
|
||
Before submitting a new issue, we kindly ask you to take a moment to search through our [existing issues](https://github.com/katspaugh/wavesurfer.js/issues?q=is%3Aissue). There's a chance that someone has already raised the point you're interested in. This step helps to keep our issues page clean and productive. | ||
|
||
## 2. Questions and Feature Requests | ||
|
||
Got a burning question or a brilliant feature idea? That's fantastic! But instead of the issues section, we ask you to post these in our [Discussions](https://github.com/katspaugh/wavesurfer.js/discussions/categories/ideas) forum. This helps to separate enhancement ideas and questions from the bugs and issues which need immediate attention from the developers. | ||
|
||
To visit the forum, [click here](https://github.com/katspaugh/wavesurfer.js/discussions). | ||
|
||
## 3. Reporting Bugs | ||
|
||
Stumbled upon a bug? Sorry about that! We're constantly working to improve wavesurfer.js and your bug reports help us do just that. | ||
|
||
When you post a bug report, please include the necessary code that will help us reproduce the bug. The more details you provide, the quicker we can get to the root of the problem and resolve it. | ||
|
||
By following these guidelines, you're helping us maintain a productive, organized community. We can't wait to see your contributions to wavesurfer.js. Thank you again for your help! |