---
# System prepended metadata

title: Process improvements

---

# Process improvements

## Changelog

The following document details out a process to keep and maintain the changelog .
https://keepachangelog.com/en/1.0.0/

If everyone agrees to the general idea I can add more details to this section 


## Git Hygiene 

We need to start following a process for maintaning and adding code to our repo . The git flow for every team , every project is different and we need to follow a process that works for us . 

This is a sample flow , we can make changes to this to accomodate everyone on the team 
https://www.notion.so/findora/Github-Workflow-93fa0f5ab451432e89b8baccec82279b

A useful tool for commits 
http://commitizen.github.io/cz-cli/

## Findora Docs 

### Context
Currently we have technical docs primarily present in the findora Wiki repo . 
https://github.com/FindoraNetwork/findora-wiki/tree/main/docs . 

And our code resides in the platform repo , with the wiki repo being referenced in some cases ,for example.
https://github.com/FindoraNetwork/platform/blob/main/docs/staking/user_guide.md

### Proposal
We can centralize the docs , to the platform repo . Using the following steps 

- Every module that we develop , should have a docs section which has docs with details like follows
    - product-spec.md   `Details on the product spec .Should ideally come from the product team`
    - technical-spec.md `Details on the module design , layout and arch`
    - user-flow.md      `Cli commands / Rest endpoint on how to use this module , how an external user can make these api calls`
  A module here means individual funtionality like `staking` or `evm`
  
- We would create a CI job to do the following on every pr
    - Check of all md files in repo . Use regex to match *.md
        - If matched get folder names 
        - copy file to the same folder in findora wiki 

### Advantages
- The Findora Wiki repo can be read only , with write access only to the CI job .
- The Platform repo will be the single source of truth.Developers are expected to add documentation in the PR's when they raise a request to merge to develop .


     