Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 4.33 KB

CONTRIBUTING.md

File metadata and controls

104 lines (75 loc) · 4.33 KB

Contributing to Bayat Development Conventions

Thank you for your interest in contributing to our development conventions! This document provides guidelines and instructions for contributing to this repository.

Table of Contents

Code of Conduct

This project adheres to a Code of Conduct that all contributors are expected to follow. By participating, you are expected to uphold this code.

How Can I Contribute?

There are several ways you can contribute to this repository:

  • Propose new conventions: Identify gaps in our current conventions and propose new ones
  • Suggest improvements: Provide feedback on existing conventions
  • Report inconsistencies: Help us identify conflicting or unclear guidelines
  • Improve documentation: Fix typos, clarify wording, add examples
  • Share implementation examples: Provide real-world examples of conventions in action

Proposing New Conventions

When proposing a new convention:

  1. First, check existing documentation to ensure this isn't already covered
  2. Create a new issue using the "New Convention Proposal" template
  3. Clearly articulate:
    • The problem this convention solves
    • Why it's important
    • How it aligns with other conventions
    • Examples of implementation
  4. Be prepared to discuss and iterate on your proposal

Suggesting Changes to Existing Conventions

When suggesting changes to existing conventions:

  1. Create a new issue using the "Convention Change" template
  2. Reference the specific document/section you're addressing
  3. Clearly explain the rationale for the change
  4. Provide alternative approaches if applicable

Pull Request Process

  1. Fork the repository

  2. Create a new branch for your changes

  3. Make your changes following our documentation standards

  4. Run validation scripts locally:

    make validate
make check-links

  5. Submit a pull request with a clear description of the changes

  6. Address any feedback from reviewers

Documentation Standards

All contributions must follow our documentation standards:

  1. Use Markdown format consistently
  2. Include proper headers (run make add-headers if needed)
  3. Follow the established directory structure
  4. Use clear, concise language
  5. Include examples where helpful
  6. Link to related documentation when appropriate

Review Process

All contributions will be reviewed by the platform team. The review process includes:

  1. Documentation quality check
  2. Technical accuracy verification
  3. Consistency check with existing conventions
  4. Feedback and requested changes if necessary

Significant changes to conventions may require broader stakeholder review and approval.

Code Contribution Guidelines

To ensure consistency and quality, please adhere to the following guidelines when contributing code:

  1. Follow Coding Standards: Ensure your code follows the relevant language and framework conventions documented in the docs directory. Key standards include:
  2. Write Tests: Include appropriate unit, integration, or end-to-end tests for your changes. Refer to the Testing Standards.
  3. Document Your Code: Add necessary comments and documentation following the Code Documentation Standards.
  4. Follow Git Conventions: Use the Bayat Git Flow and adhere to the Commit Message Standards.
  5. Pass CI Checks: Ensure all automated checks (linting, tests, builds) pass before submitting a Pull Request.
  6. Code Reviews: Participate actively in the code review process as outlined in the Code Review Standards.

Thank you for contributing to our development conventions!