Skip to content

Latest commit

 

History

History
63 lines (51 loc) · 2.64 KB

CONTRIBUTION.md

File metadata and controls

63 lines (51 loc) · 2.64 KB

Contribution and style guidelines

Welcome to the contribution guidelines for the QA architecture handbook! We appreciate your interest in contributing to this project and helping us build a valuable resource for the community.

How to contribute

To contribute to the QA architecture handbook, you can follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Install the necessary dependencies (yarn install, it'll also setup pre-commit hooks).
  5. Make your changes to the content.
  6. Commit your changes with a clear and descriptive commit message.
    1. If pre-commit hooks fail, please address the issues raised by the checks.
  7. Push your changes to your forked repository.
  8. Create a pull request to the main repository.
  9. Wait for the maintainers to review your changes.

Contribution guidelines

When contributing to the QA architecture handbook, please follow these guidelines:

  • Be respectful: Treat others with respect, kindness, and empathy. We welcome contributions from all individuals.
  • Be clear and concise: Write clear and concise content that is easy to understand and follow.
  • Be informative: Provide valuable insights, practical advice, and relevant examples to enhance the content.
  • Be consistent: Follow the existing style and formatting guidelines to maintain a cohesive structure.

Style guidelines

To maintain consistency and readability across the handbook, please follow these style guidelines:

  • Use headings and subheadings: Organize the content with headings and subheadings to create a clear hierarchy.
  • Use numbered subheadings: Use numbered subheadings to indicate the hierarchy of sections and subsections. (like 1.1, 1.1.1, 1.1.2, etc.)
  • Use bullet points for lists: Use bullet points for lists of items to improve readability.
  • Use code blocks for code snippets: Enclose code snippets in code blocks to distinguish them from regular text.
  • Use bold for emphasis: Use bold text to highlight key points, terms, or concepts.
  • Use italics for emphasis: Use italics to emphasize specific words or phrases.
  • Use links for references: Use hyperlinks to reference external resources, tools, or related content.
  • Use images for visual aids: Include images, diagrams, or charts to enhance the visual appeal and understanding of the content.

Authorship

When contributing to the QA architecture handbook, your contributions will be shown in AUTHORS.md file when merged. That's why it's important to provide your name and email address in the commit message.