CONTRIBUTING.md

Contribution Guidelines

Welcome! We're excited that you're interested in contributing to this project. This repository serves as a central hub for documenting coding standards, CI setups, and other development practices related to various programming languages. Your contributions will help developers across the community adhere to best practices and streamline their development workflows.

Table of Contents

• Contribution Guidelines
  • Table of Contents
  • Getting Started
    • Fork the Repository
    • Clone the Repository
  • Making Contributions
    • Creating or Editing a Guide
  • Formatting Guidelines
    • Markdown
    • Images
  • Submitting Your Changes
  • Review Process

Getting Started

Fork the Repository

To contribute to the Dev Standards Repository, start by forking this repository to your own GitHub account. This will create a copy of the repository that you can freely make changes to.

Clone the Repository

Once you've forked the repository, clone your fork to your local machine using the following command:

git clone https://github.com/your-username/dev-standards.git

Making Contributions

Creating or Editing a Guide

If you'd like to add a new guide or edit a existing guide to the repository, follow these steps:

1. Create a new branch for your changes with a meaningful branch name:

   git checkout -b your-branch-name

2. Locate the relevant .md file or create a new .md Markdown file inside the appropriate directory within the repository.

3. Write your guide using Markdown syntax. Ensure your guide is clear, concise, and follows the formatting guidelines outlined below.

Formatting Guidelines

Markdown

• Maintain a consistent Markdown formatting style throughout the guide.
• Use appropriate headers, bullet points, and numbered lists for clear organization.
• Use code blocks to highlight code snippets or configuration examples.
• Incorporate links to relevant resources or external references when necessary.

Images

• Images are stored in the assets directory within the appropriate folder.
• Optimize images for web usage and ensure they do not significantly increase the repository's size.

Submitting Your Changes

Once you're satisfied with your edits:

1. Commit your changes with clear and concise commit messages. Follow this guide to create a meaningful commit message.
2. Push your changes to your forked repository on GitHub.

Review Process

• Pull requests will be reviewed by the repository maintainers.
• Expect feedback or suggestions for further improvements to enhance the quality of your contribution.
• Once your edits are approved, they will be merged into the main repository.