diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bfc5199 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,54 @@ +# Contributing to Runlet + +Welcome, and thank you for your interest in contributing to Runlet! + +There are many ways in which you can contribute. This document provides an overview of how you can get involved. + +## Asking Questions + +Have a question? Rather than opening an issue, please ask away on [Stack Overflow](https://stackoverflow.com/questions/tagged/runlet) using the tag `runlet`. Your well-worded question will serve as a resource to others searching for help. + +## Providing Feedback + +Have you identified a reproducible problem in Runlet? Have a feature request? We want to hear about it! + +[GitHub issues](https://github.com/runletapp/runlet/issues) should be used for bugs and feature requests. Notice, we don't want to use Github Issues for general 'how-to' questions about Runlet. We will therefore redirect general 'how-to' questions to Stack Overflow. + +### Look For an Existing Issue + +Before you create a new issue, please do a search in [open issues](https://github.com/runletapp/runlet/issues) to see if the issue or feature request has already been filed. + +Be sure to scan through the [most popular](https://github.com/runletapp/runlet/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) feature requests. + +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 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 we will be successful at reproducing the issue and finding a fix. + +Please include the following with each issue: + +* Version of Runlet + +* Your operating system + +* 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 + +We will ask for more information if we can't reproduce the issue right away. + +# Thank You! + +Thank you for taking the time to contribute. \ No newline at end of file diff --git a/README.md b/README.md index 1333ed7..0b6c959 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -TODO +# Runlet logo [Runlet](https://runlet.app) + +[![Build Status](https://dev.azure.com/runletapp/runlet/_apis/build/status/GustavoKatel.runletapp?branchName=master)](https://dev.azure.com/runletapp/runlet/_build/latest?definitionId=2&branchName=master) +![GitHub release](https://img.shields.io/github/release/runletapp/runlet) +![GitHub All Releases](https://img.shields.io/github/downloads/runletapp/runlet/total) +[![Bugs](https://img.shields.io/github/issues/runletapp/runlet/bug.svg)](https://github.com/runletapp/runlet/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Abug) +[![Feature Requests](https://img.shields.io/github/issues/runletapp/runlet/feature-request.svg)](https://github.com/runletapp/runlet/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) + +Runlet is a cloud-based job manager that offers device synchronization and reliable message delivery in a network of connected devices even after connectivity issues. This repository is where new releases are published, bugs are reported, and features are requested. + +## Download + +The desktop distribution includes both the daemon and a full-featured GUI, and is recommended for Linux, Mac and Windows users. The ARM distribution includes only the daemon, and is recommended for resource constrained devices like the Raspberry Pi. + +All available distributions and versions can also be found at [releases](https://github.com/runletapp/runlet/releases). + +## Contributing + +There are a couple of ways in which you can contribute to the app, for example: + +* [Submit bugs and feature requests](https://github.com/runletapp/runlet/issues), and help us verify as they are checked in +* Review the [documentation](https://runlet.gitbook.io) and make pull requests for anything from typos to new content suggestion + +## Feedback + +* Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/runlet) +* [Report an issue](https://github.com/runletapp/runlet/issues) +* [Request a new feature](CONTRIBUTING.md) +* Up vote [popular feature requests](https://github.com/runletapp/runlet/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) +* Follow [@runletapp](https://twitter.com/runletapp) and let us know what you think! + +## License + +Copyright (c) Runlet. All rights reserved. \ No newline at end of file