mirror of
https://github.com/XFox111/GUTSchedule.git
synced 2026-04-22 06:58:01 +03:00
Michael Gordeev
84 lines
3.3 KiB
Markdown
84 lines
3.3 KiB
Markdown
# GUTSchedule Contribution Guidelines
|
|
|
|
Welcome, and thank you for your interest in contributing to my app!
|
|
|
|
There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
|
|
|
|
## Asking Questions
|
|
|
|
Have a question? Rather than opening an issue, please ask me directly on opensource@xfox111.net.
|
|
|
|
## Providing Feedback
|
|
|
|
Your comments and feedback are welcome.
|
|
You can leave your feedbak on my app on feedback@xfox111.net or leave a review on [Google Play](https://play.google.com/store/apps/details?id=com.xfox111.gut.schedule)
|
|
|
|
## Reporting Issues
|
|
|
|
Have you identified a reproducible problem in the application? Have a feature request? I'd like to hear it! Here's how you can make reporting your issue as effective as possible.
|
|
|
|
### Look For an Existing Issue
|
|
|
|
Before you create a new issue, please do a search in [open issues](https://github.com/xfox111/gutschedule/issues) to see if the issue or feature request has already been filed.
|
|
|
|
Be sure to scan through the [feature requests](https://github.com/XFox111/GUTSchedule/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement).
|
|
|
|
If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment:
|
|
|
|
* 👍 - upvote
|
|
* 👎 - downvote
|
|
|
|
If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.
|
|
|
|
### Writing Good Bug Reports and Feature Requests
|
|
|
|
File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.
|
|
|
|
Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.
|
|
|
|
The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.
|
|
|
|
Please include the following with each issue:
|
|
- Current version of the app
|
|
- Your current Android version
|
|
- Reproducible steps (1... 2... 3...) that cause the issue
|
|
- What you expected to see, versus what you actually saw
|
|
- Images, animations, or a link to a video showing the issue occurring
|
|
|
|
### Final Checklist
|
|
|
|
Please remember to do the following:
|
|
* [ ] Search the issue repository to ensure your report is a new issue
|
|
* [ ] Separate issues reports
|
|
* [ ] Include as much information as you can to your report
|
|
|
|
Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!
|
|
|
|
### Follow Your Issue
|
|
|
|
Once your report is submitted, be sure to stay in touch with the devs in case they need more help from you.
|
|
|
|
## Contributing Fixes
|
|
|
|
If you are interested in writing code to fix issues you can follow this guidelines to get a better result
|
|
|
|
> // TODO: Complete guidelines
|
|
|
|
### Build and run project
|
|
|
|
### Development workflow
|
|
|
|
### Coding guidelines
|
|
|
|
### Submitting pull requests
|
|
|
|
### Finding an issue to work on
|
|
|
|
### Contributing to translations
|
|
|
|
# Thank You!
|
|
|
|
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.
|
|
|
|
## Attribution
|
|
This Contribution Guidelines are adapted from the [Contributing to VS Code](https://github.com/microsoft/vscode/blob/master/CONTRIBUTING.md) |