Skip to content

Commit 974da58

Browse files
CONTRIBUTING.md committed
1 parent b8559c1 commit 974da58

1 file changed

Lines changed: 74 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributing to [project-title]
2+
3+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
4+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
5+
the rights to use your contribution. For details, visit [Contributor License Agreements](https://cla.opensource.microsoft.com).
6+
7+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
8+
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
9+
provided by the bot. You will only need to do this once across all repos using our CLA.
10+
11+
- [Code of Conduct](#coc)
12+
- [Issues and Bugs](#issue)
13+
- [Feature Requests](#feature)
14+
- [Submission Guidelines](#submit)
15+
16+
## <a name="coc"></a> Code of Conduct
17+
Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
18+
19+
## <a name="issue"></a> Found an Issue?
20+
If you find a bug in the source code or a mistake in the documentation, you can help us by
21+
[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can
22+
[submit a Pull Request](#submit-pr) with a fix.
23+
24+
## <a name="feature"></a> Want a Feature?
25+
You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub
26+
Repository. If you would like to *implement* a new feature, please submit an issue with
27+
a proposal for your work first, to be sure that we can use it.
28+
29+
* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
30+
31+
## <a name="submit"></a> Submission Guidelines
32+
33+
### <a name="submit-issue"></a> Submitting an Issue
34+
Before you submit an issue, search the archive, maybe your question was already answered.
35+
36+
If your issue appears to be a bug, and hasn't been reported, open a new issue.
37+
Help us to maximize the effort we can spend fixing issues and adding new
38+
features, by not reporting duplicate issues. Providing the following information will increase the
39+
chances of your issue being dealt with quickly:
40+
41+
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
42+
* **Version** - what version is affected (e.g. 0.1.2)
43+
* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
44+
* **Browsers and Operating System** - is this a problem with all browsers?
45+
* **Reproduce the Error** - provide a live example or a unambiguous set of steps
46+
* **Related Issues** - has a similar issue been reported before?
47+
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
48+
causing the problem (line of code or commit)
49+
50+
You can file new issues by providing the above information at the corresponding repository's issues link:
51+
replace`[organization-name]` and `[repository-name]` in
52+
`https://github.com/[organization-name]/[repository-name]/issues/new` .
53+
54+
### <a name="submit-pr"></a> Submitting a Pull Request (PR)
55+
Before you submit your Pull Request (PR) consider the following guidelines:
56+
57+
* Search the repository's [pull requests](https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
58+
that relates to your submission. You don't want to duplicate effort.
59+
60+
* Make your changes in a new git fork:
61+
62+
* Commit your changes using a descriptive commit message
63+
* Push your fork to GitHub:
64+
* In GitHub, create a pull request
65+
* If we suggest changes then:
66+
* Make the required updates.
67+
* Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
68+
69+
```shell
70+
git rebase main -i
71+
git push -f
72+
```
73+
74+
That's it! Thank you for your contribution!

0 commit comments

Comments
 (0)