|
1 | 1 | # Contributing to Ploty.rs
|
2 | 2 |
|
3 |
| -Contribution in the form of suggestions, bug reports, pull requests and feedback is welcome from everyone. In this document |
4 |
| -you'll find guidance if you are considering to offer your help to this project. |
| 3 | +Contribution in the form of suggestions, bug reports, pull requests and feedback is welcome from everyone. In this document you'll find guidance if you are considering to offer your help to this project. |
5 | 4 |
|
6 |
| -## Submitting bug reports and feature requests |
| 5 | +## Submitting Bug Reports and Feature Requests |
7 | 6 |
|
8 |
| -When reporting a bug or asking for help, please include enough details so that |
9 |
| -the people helping you can reproduce the behavior you are seeing. For some tips |
10 |
| -on how to approach this, read about how to produce a [Minimal, Complete, and |
11 |
| -Verifiable example]. |
| 7 | +When reporting a bug or asking for help, please include enough details so that the people helping you can reproduce the behavior you are seeing. For some tips on how to approach this, read about how to produce a [Minimal, Complete, and Verifiable example]. |
12 | 8 |
|
13 | 9 | [Minimal, Complete, and Verifiable example]: https://stackoverflow.com/help/mcve
|
14 | 10 |
|
15 |
| -When making a feature request, please make it clear what problem you intend to |
16 |
| -solve with the feature, any ideas for how Plotly.rs could support solving that |
17 |
| -problem, any possible alternatives, and any disadvantages. |
| 11 | +When making a feature request, please make it clear what problem you intend to solve with the feature, any ideas for how Plotly.rs could support solving that problem, any possible alternatives, and any disadvantages. |
18 | 12 |
|
19 |
| -## Process |
| 13 | +## Pull Requests |
20 | 14 |
|
21 |
| -Before spending time and effort in making changes to the library, please open an issue first explaining the proposed change |
22 |
| -and indicate that you would be happy to implement/fix the issue. Once the utility of the addition is discussed and verified, |
23 |
| -you're welcome to proceed. |
| 15 | +Before spending time and effort in making changes to the library, it's a good idea to discuss it first on the issue tracker to see whether your change is likely to be accepted. |
24 | 16 |
|
25 |
| -Fork [plotly](https://igiagkiozis.github.io/plotly/) to your own account and checkout the `dev` branch. Once the bug/feature is complete, make sure you update |
26 |
| -appropriately the [change log](CHANGELOG.md). |
| 17 | +Fork [plotly](https://igiagkiozis.github.io/plotly/) to your own account and create a new branch for your feature. Remember to update the [changelog](CHANGELOG.md) - use previous entries as a template. |
27 | 18 |
|
28 |
| -For change-log updates please use previous entries as reference, namely classify |
29 |
| -the nature of the change, e.g. fixed, changed, added etc., and a brief description. The entry in the change-log that should be |
30 |
| -used for the update will always be marked with YEAR-XX-XX, e.g. 2022-XX-XX. |
31 |
| - |
32 |
| -Check that the test suite passes locally and that all examples still execute and produce the expected results before submitting a pull request. |
33 |
| - |
34 |
| -Make a pull request with your changes directly to the `dev` branch. Please note, pull requests to the `master` branch will not |
35 |
| -be considered. The `master` branch is reserved for release. |
36 |
| - |
37 |
| - |
38 |
| -Also, include a description of our changes as documented in the |
39 |
| -[change-log](CHANGELOG.md); just copy paste these additions in the pull request description. Wait for one of the reviewers |
40 |
| -to look at your code and either merge it or give feedback which you should adapt to. |
| 19 | +When your contribution is ready for review, make a pull request with your changes directly to the `master` branch. One of the maintainers will have a look at what you've done, suggest any necessary changes and, when everyone is happy, merge the pull request. |
41 | 20 |
|
42 | 21 | ## Code of Conduct
|
43 | 22 |
|
|
0 commit comments