Skip to content

Commit e961205

Browse files
author
dcyoung
committed
Added templates for contribution, pull requests and issues.
1 parent 18cb475 commit e961205

File tree

3 files changed

+67
-0
lines changed

3 files changed

+67
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Help
2+
The [issues](https://github.com/scanse/sweep-arduino/issues) section is for bug reports and feature requests. If you need help with a project, please use the [community](http://community.scanse.io/) forum.
3+
4+
---
5+
# Bugs
6+
#### Before reporting a bug
7+
8+
1. Search [issue tracker](https://github.com/scanse/sweep-arduino/issues) for similar issues.
9+
2. Make sure you are using the latest version of the code, and that you have thoroughly reviewed all provided documentation.
10+
3. Make sure you are using the latest version of the sweep firmware that is compatible with the arduino code.
11+
12+
#### How to report a bug
13+
14+
1. Describe the problem in detail. Explain what happened, and what you expected would happen.
15+
2. If it makes things more clear, include a code snipper or an annotated screenshot.
16+
17+
---
18+
# Contribution
19+
The `sweep-arduino` repository will evolve much more quickly with community contribution! We will work hard to integrate valuable changes, improvements and features. To make the process more efficient, here are some general steps to contribute.
20+
21+
#### How to contribute
22+
23+
1. Login or create a GitHub account.
24+
2. Fork the repository on GitHub.
25+
3. Make changes to your fork of the repository.
26+
4. Check the [Contribution Guidelines](PULL_REQUEST_TEMPLATE.md) for pull requests and make sure your modifications adhere to the guidelines.
27+
5. Submit your modifications as a new pull request [here](https://github.com/scanse/sweep-arduino/pulls).

.github/ISSUE_TEMPLATE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!---
2+
This form is intended mainly for bug reports and feature requests.
3+
This is NOT the place to ask for general project help. If you need help, please use the community forum available [here](http://community.scanse.io/).
4+
5+
Tips for posting an issue:
6+
Include the verison of the sweep firmware you are using.
7+
Describe the bug or feature request in detail.
8+
Explain what happened and what you expected to happen.
9+
If relevant, a code snippet, screenshot, or small-test can help people understand.
10+
11+
This text is a "template". Feel free to delete it.
12+
-->
13+
14+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!--
2+
Thank you for contributing to the sweep-arduino repository!
3+
4+
Before opening a pull request, please:
5+
6+
1. Format the modified code.
7+
Follow the format and conventions of the existing code
8+
2. Test the modified code.
9+
Try to run any and all tests or examples provided. Add any examples needed to exercise your modified code.
10+
11+
Adhering to these guidelines will help speed up the review process and get your changes integrated more quickly.
12+
-->
13+
14+
15+
#### Scope of changes
16+
<!--
17+
Describe the scope of any changes made.
18+
What does the Pull Request accomplish?
19+
Summarize what parts of the code were modified to implement the change.
20+
-->
21+
22+
#### Known Limitations
23+
<!--
24+
Describe any known limitations.
25+
If the change does not yet support a certain features note that here.
26+
-->

0 commit comments

Comments
 (0)