Skip to content

Commit

Permalink
Merge pull request #6 from VGVentures/docs/conventions
Browse files Browse the repository at this point in the history
docs: conventions
  • Loading branch information
jolexxa authored Jul 9, 2024
2 parents a05d44f + aba4d80 commit 2450b27
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
15 changes: 15 additions & 0 deletions src/content/docs/development/conventions.mdx
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.
4 changes: 3 additions & 1 deletion src/content/docs/development/philosophy.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: 🦄 Our Philosophy
description: Development philosophy at Very Good Ventures.
sidebar:
order: 0
---

import { Aside, TabItem, Tabs } from "@astrojs/starlight/components";
Expand Down Expand Up @@ -165,5 +167,5 @@ As a team, we have many cumulative years of experience with apps of all kinds, f
[correctness]: https://en.wikipedia.org/wiki/Correctness_(computer_science)
[declarative]: https://stackoverflow.com/a/15382180
[time-complexity]: https://en.wikipedia.org/wiki/Time_complexity
[very-good-layered-architecture]: https://verygood.ventures/blog/very-good-flutter-architecture
[pub.dev]: https://pub.dev
[very-good-layered-architecture]: https://verygood.ventures/blog/very-good-flutter-architecture

0 comments on commit 2450b27

Please sign in to comment.