Skip to content

This is a repo containing conventions gathered from lot's of other repositories, contributors and more.

License

Notifications You must be signed in to change notification settings

TeamPraxidike/praxiConventions

Repository files navigation

Praxi-Conventions

Made possible by all the contributors. Thank you.

This is a repository made to list numbers of conventions that can be adopted in newly created repositories while also providing templates for files or links to existing ones.

Goals and inspiration

This project is inspired by the lack of established rules and conventions in many repositories by newer developers and the desire to help create one well-documented environment that adhere to common conventions and rules.

An example of this is myself (Zakrok09). I only realized that there are conventions for commit messages and branch names really late. This repository aims to streamline the process of finding those conventions and establish professional standards more easily.

How to use this repository

Navigate in through the document structure of this repository and find the template you would like to adapt to your repository. You can copy the markdown files and edit them to your need or find mroe information if the provided template was linked to this repository and uploaded.

Document Structure

 CONVENTIONS/                # General conventions and rules to add to your repository 
     template.md             # Template conventions file
     template-sveltekit.md   # Example conventions file for a SvelteKit Project
 CODE_OF_CONDUCTS/           # CoC Templates for projects
 ...

Contributing

You can contribute in one of the following ways:

  1. Open issues to present possible templates or send links to them

  2. Forking it and merging it according to the standards.

Website

WIP