Skip to content

Commit 704e4f8

Browse files
committed
Update spelling and contributing
1 parent b99727c commit 704e4f8

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
csharpier

CONTRIBUTING.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,42 @@
11
# Contributing
22

3-
Will be written soon.
3+
Thanks for your interest in contributing to `bicep-local-docgen`! Here are a few general
4+
guidelines on contributing andreporting bugs that we ask you to review. Following these
5+
guidelines helps to communicate that you respect the time of the contributors managing
6+
and developing this open source project.
7+
8+
## Reporting Issues
9+
10+
Before reporting a new issue, please ensure that the issue was not already reported or
11+
fixed by searching through our [issues list][00].
12+
13+
When creating a new issue, please be sure to include a **title and clear description**,
14+
as much relevant information as possible, and, if possible, a test case.
15+
16+
## Sending Pull Requests
17+
18+
Before sending a new pull request, take a look at existing pull requests and issues to
19+
see if the proposed change or fix has been discussed in the past, or if the change was
20+
already implemented but not yet released.
21+
22+
We expect new pull requests to include tests for any affected behavior, and, as we
23+
follow semantic versioning, we may reserve breaking changes until the next major version
24+
release.
25+
26+
## Other Ways to Contribute
27+
28+
We welcome anyone that wants to contribute to `bicep-local-docgen` to triage and reply to
29+
open issues to help troubleshoot and fix existing bugs. Here is what you can do:
30+
31+
- Help ensure that existing issues follows the recommendations from the _[Reporting Issues][01]_
32+
section, providing feedback to the issue's author on what might be missing.
33+
instructions and code samples.
34+
- Review existing pull requests, and testing patches against real existing applications that use
35+
`bicep-local-docgen`.
36+
- Write a test, or add a missing test case to an existing test.
37+
38+
Thanks again for your interest on contributing to `bicep-local-docgen`!
39+
40+
<!-- Link reference definitions -->
41+
[00]: https://github.com/Gijsreyn/bicep-local-docgen/issues
42+
[01]: #reporting-issues

0 commit comments

Comments
 (0)