iicd/Inkycal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Ace
2019-06-02 15:42:49 +02:00
committed by GitHub
parent ce4b75d86c
commit 6aa082d2cb
1 changed files with 4 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@@ -5,9 +5,6 @@ Thanks for contributing to the E-Paper Calendar Software!
If you wish to contribute, please test your suggestion for at least one week on your own E-Paper first. Often, a small change makes a lot
of difference so it's important to check how well your suggestion can perform.
A testing time for 1 week is set as the E-Paper software takes 1 days for a daily cycle, 7 days for a weekly cycle and 1 month for a
montly cycle. Usually, if it works for the daily and weekly cycle, there shouldn't be any issues in the monthly cycle.
# Code contributions
Code contrubutions are most welcome. If you want to contrubite, please fork the main repo, apply changes to your own branch or a new one, test it for at least one week (see above) and then submit a Pull Request. Lastly, don't forget to add your name to the file `CONTRIBUTORS.md`. Thank You!
@@ -18,16 +15,11 @@ Please only submit reproducible issues and write the instructions on how to repr
When you are submitting a new issue, please supply the following information:
* **Version info;** Copy the data inside the Info.txt file (`/home/pi/E-Paper-Master/Info.txt`). If there's no such file, you are using an outdated version. Please consider updating.
### Release version
* **Error output:** Any errors of the Main script can be found in `/home/pi/E-Paper-Master/E-Paper-err.log`. You don't need to copy the entire file (please don't) but rather the latest errors that occured.
### Expected behavior
* **Changes made:** If you have made any changes (apart from personal information), also include them to help debugging.
### Actual behavior
* **Description**: Provide a detailed description about the issue and include specific details to help us understand the problem. Adding screenshots will help describing the problem.
### Steps to reproduce the behavior
* **Steps to reproduce:** List the step by step process to reproduce the issue.
* **Results**: Describe what you expected to see and what you actually saw.
* **Additional Notes:** Provide any other relevant notes not previously mentioned. This is optional.