Documentation, template files and descriptions for while-true-do.io.
Some documents and files need to be maintained accross multiple repositories. This often leads to inconsistencies and fragmented information. Having a default place to create and update such files and documents is desired.
The repository uses a functionality of GitHub, where you can provide certain documents and use them as default documents for all repositories in an organization.
Issue templates are a feature from GitHub, so users and contributors can open new issues in an easy and convenient way. This will also providing options for maintainers to ask for information and suggest a proper format for issues.
You can find the default issues in the .github directory. Repository owners are free to add more templates to the repositories, if needed.
In addition to templates a community like while-true-do.io has common guidelines and documents. These are maintained here, too. You can find the documents in the docs directory. Other repository can/should link to the documents by default.
The .github repository is also used to provide an entry point for the organisation. The file profile/README.md is published in the project overview and visible for every visitor and contributor. It should contain common information, so new members, contributors, committers and users can find some entrypoints.
Thank you so much for considering to contribute! We are happy, when someone is joining the hard work.
Issues and Pull Requests are handled on a regular basis. Please be aware, that we may reach out to you, ask you to provide additional resources or want to discuss the issue a little, before planning it.
Providing code to this repository is pretty straight forward. Open an issue, so we can discuss the bug/feature and start working on it afterwards. You just need to open the pull request afterwards and that's it.
It is also strongly recommended to read the Contribution Guideline beforehand.
We are maintaining a changelog for repositories. Normally, the developers will update the changelog, according to keepachangelog.com.
To ensure a high quality and functionality, we want to carefully test our software. The provided code is automatically tested as described in the .cirrus.yml.
Except otherwise noted, all work is licensed under a BSD-3-Clause License.
Please feel free to reach out to us and the community. We also recommend to read and understand the Code of Conduct beforehand.
- Site: https://while-true-do.io
- Blog: https://blog.while-true-do.io
- Code: https://github.com/whiletruedoio
- Chat: Matrix
- Mail: [email protected]