-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from VGVentures/docs/conventions
docs: conventions
- Loading branch information
Showing
2 changed files
with
18 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: 📖 Conventions | ||
description: Recommended conventions within software development. | ||
sidebar: | ||
order: 1 | ||
--- | ||
|
||
There are a handful of external development standards and conventions that we encourage developers to familiarize themselves with. | ||
|
||
- 📄 [Diátaxis](https://diataxis.fr/) — a systematic approach to technical documentation authoring. | ||
- 🎎 [Semantic Versioning](https://semver.org/) — a versioning scheme for software. | ||
- 💠 [Conventional Commmits](https://www.conventionalcommits.org/en/v1.0.0/) — a specification for adding human and machine readable meaning to commit messages. | ||
- 🪵 [Keep a Changelog](https://keepachangelog.com/) — a specification for maintaining a changelog. | ||
- 🧊 [Opinionated "Recommended" Practices for flutter_bloc](https://github.com/chonghorizons/flutter_bloc_opinionated_practices/wiki/Opinionated-%22Recommended%22-Practices-for-flutter_bloc) | ||
- 🤝 [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) — code of conduct designed to promote a welcoming and inclusive community. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters