You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ Thanks for your interest in contributing to this free open source project! We ap
3
3
4
4
## Issues
5
5
- Do you need help or have a question about using Arduino? Support requests should be made to the appropriate section of the [Arduino forum](http://forum.arduino.cc) rather than an issue report. **Issue reports are to be used to report bugs or make feature requests only.**
6
-
- Search [existing pull requests and issues](https://github.com/JSC-electronics/ObjectButton/issues?q=) to be sure it hasn't already been reported. If you have additional information to provide about an existing issue then please comment on that issue.
6
+
- Search [existing pull requests and issues](https://github.com/JSC-TechMinds/ObjectButton/issues?q=) to be sure it hasn't already been reported. If you have additional information to provide about an existing issue then please comment on that issue.
7
7
- State the newest version of the Arduino IDE you have verified the issue with and which operating system you are using.
8
8
- If you are using this library on PlatformIO, report version of PlatformIO Core and which operating system you are using.
9
9
- The issue title should be concise yet descriptive. Vague titles make it difficult to know the purpose of the issue when looking through the list of reports and may cause your issue to not be given proper attention.
@@ -13,7 +13,7 @@ Thanks for your interest in contributing to this free open source project! We ap
13
13
- If you find a solution to your problem update your issue report with an explanation of how you were able to fix it and close the issue.
14
14
15
15
## Pull Requests
16
-
- Search [existing pull requests](https://github.com/JSC-electronics/ObjectButton/pulls?q=) to see if one has already been submitted for this change. Search the [issues](https://github.com/JSC-electronics/ObjectButton/issues?q=is%3Aissue) to see if there has been a discussion on this topic and whether your pull request can close any issues.
16
+
- Search [existing pull requests](https://github.com/JSC-TechMinds/ObjectButton/pulls?q=) to see if one has already been submitted for this change. Search the [issues](https://github.com/JSC-TechMinds/ObjectButton/issues?q=is%3Aissue) to see if there has been a discussion on this topic and whether your pull request can close any issues.
17
17
- Code formatting should be consistent with the style used in the existing code.
18
18
- Don't leave commented out code. A record of this code is already preserved in the commit history.
19
19
- All commits must be atomic. This means that the commit completely accomplishes a single task. Each commit should result in fully functional code. Multiple tasks should not be combined in a single commit, but a single task should not be split over multiple commits (e.g. one commit per file modified is not a good practice). For more information see http://www.freshconsulting.com/atomic-commits.
@@ -29,7 +29,7 @@ Thanks for your interest in contributing to this free open source project! We ap
29
29
- Rebasing pull requests is OK and encouraged. After submitting your pull request some changes may be requested. Rather than adding unnecessary extra commits to the pull request, you can squash these changes into the existing commit and then do a force push to your fork. When you do a force push to your fork, the PR will be updated with your new changes, so there is no need to open a new PR to make changes. Leave a comment on the pull request thread to explain that the history has been changed. This will help to keep the commit history of the repository clean.
30
30
- Make sure your change does not break existing unit tests (see below for more details).
31
31
- After your pull request is merged please update the documentation if the changes require it:
This library uses [Arduino CI](https://github.com/ianfixes/arduino_ci) as a unit test framework. When you create a pull request, your code will be tested against existing test cases. Sometimes it may be useful to test the code locally to save time. Please follow the instructions on Arduino CI page.
@@ -43,7 +43,7 @@ Requirements to build and run the unit tests:
ObjectButton is an Arduino library for detecting common button actions. Because of it, you can map different functions into a single button, i.e. turn on the light on a button click and play an alarm sound on double-click.
@@ -63,15 +63,15 @@ This library comes with reasonable defaults for detecting all the actions. Howev
63
63
## Contributing
64
64
There are many ways in which you can participate in the project, for example:
65
65
66
-
*[Submit bugs and feature requests](https://github.com/JSC-electronics/ObjectButton/issues), and help us verify as they are checked in
sentence=An Arduino library for detecting button actions.
6
6
paragraph=ObjectButton is an Arduino library for detecting common button actions. Because of it, you can map different functions into a single button, i.e., turn on the light on a button click and play an alarm sound on double-click.
0 commit comments