Development • Documentation • Contribute • Support
Provide a short description of the project. Make the README inviting and encouraging for anybody who comes across your project and wants to check it out or contribute.
- Do this first
- Then do this
- Run this trustworthy command
echo "I won't do any evil on your system!"Provide the build instructions step by step. Be as precise as possible and mention all necessary steps. This might also serve as a reference for your future self.
- Do this first
- Then do this
- Run this trustworthy command
echo "I won't do any evil on your system!"- Do this first
- Then do this
- Run this trustworthy command
echo "I won't do any evil on your system!"Here you should provide all the information one should know before starting to contribute. Provide some information about the branching model, naming conventions, development tools, etc.
Describe which linting tool you are using and how to install it.
Describe how tests can be run. Do not forget to add instructions if a specific setup is required.
Provide all the links to external resources like architecture diagrams or documentaion. You can also put a diagram here, but if the section grows too big, think about making it its own markdown file and link it here.
(optional): Here you can list people who have developed this project.
If your project has linked or related projects you can list the other repos here:
| Repository | Description |
|---|---|
| related-project | Short Description |
| 2nd-related-project | Short Description |
The following channels are available for discussions, feedback, and support requests:
| Type | Channel |
|---|---|
| General Discussion | |
| Concept Feedback | |
| iOS App Issue | |
| Backend Issue | |
| Other Requests |