Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (61 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

94 lines (61 loc) · 3.07 KB

Contributing to Asper Header

Thank you for considering contributing to Asper Header! This document outlines the guidelines and processes for making contributions to the project.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Coding Guidelines
  4. Commit Message Convention
  5. Pull Request Process
  6. Setting Up the Development Environment

Code of Conduct

We adhere to a Code of Conduct to ensure a welcoming and inclusive environment for all contributors. Please read it before contributing.

How to Contribute

Reporting Issues

If you encounter a bug or have a question:

  1. Check if the issue has already been reported in the Issues section.
  2. If not, create a new issue using the Bug Report or Question template.
  3. Include detailed steps to reproduce the bug or context about your question.

Feature Requests

To propose a new feature:

  1. Check if the feature has already been requested.
  2. Open a new issue using the Feature Request template.
  3. Clearly describe the problem the feature solves and, if possible, provide examples of how it would be used.

Submitting Changes

To contribute code:

  1. Fork the repository.
  2. Create a new branch following the naming convention: feature/<description> or fix/<description>
  3. Make your changes following the Coding Guidelines.
  4. Test your changes thoroughly.

Coding Guidelines

  • Follow the repository’s style guide and adhere to best practices.
  • Ensure all code is well-documented and includes meaningful comments.
  • Write tests where applicable and ensure all existing tests pass.
  • Use the following tools (if applicable):
    • Docker for containerization.
    • Github Action for CI/CD.

Commit Message Convention

All commit messages must follow the format below: [INFLECTED VERB] <concise description>

See COMMIT_CONVENTION.md for details and examples.

Pull Request Process

  1. Ensure your branch is up to date with the main branch.

  2. Create a pull request with a clear title and description of your changes.

  3. Link any relevant issues in the pull request description.

  4. Ensure the following checks pass:

    • Code adheres to the guidelines.
    • All tests pass.
    • There are no conflicts with the main branch.

  5. A reviewer will assess your pull request. Please address their feedback promptly.

Setting Up the Development Environment

In order to set up the development environement, it is recommended to follow the Getting started - Dependencies - From Source

This section contains the necessary information to allow you to compile the project (and your changes) using CMake.