repo-includes-common-docs (SGA-GL-0007)

Why it matters

Including a ‘docs/’ directory with common documentation files helps in maintaining a clear structure for project documentation, making it easier for contributors and users to find relevant information. It also promotes better collaboration and understanding of the project.

How it works

Create a ‘docs/’ directory in the root of your repository. Inside this directory, include common documentation files such as ‘index.md’, ‘CONTRIBUTING.md’, ‘CODE_OF_CONDUCT.md’, and any other relevant documentation files that provide information about the project, its usage, and contribution guidelines. You can use Markdown to format these files for better readability. If you’re using GitHub, you can also use their web interface to create and edit these files directly within the ‘docs/’ directory.