Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

76 lines (57 loc) · 2.54 KB
Raw

Contributing to cavi-cmn

Thank you for considering contributing to cavi-cmn! We appreciate your interest in improving the project. Before you begin, please take a moment to review the guidelines below.

How to Contribute

1. Reporting Issues

If you find a bug, have a feature request, or need help, please open an issue and provide the following details:

  • A clear and descriptive title
  • Steps to reproduce the issue (if applicable)
  • The expected behavior
  • The actual behavior
  • Any other relevant information (e.g., environment, version)

2. Submitting Pull Requests

We welcome pull requests for bug fixes, enhancements, documentation improvements, and new features. To get started:

  1. Fork the Repository

    • Create a personal fork of the repository by clicking the "Fork" button at the top of this page.

  2. Clone the Fork

    • Clone your fork to your local machine: 
      git clone https://github.com/your-username/your-repository-name.git
    • Navigate to the project directory: 
      cd your-repository-name

  3. Create a New Branch

    • Create a new branch for your work: 
      git checkout -b feature/your-feature-name
    • Keep your branch names descriptive and concise.

  4. Make Changes

    • Implement your changes following the project’s code style and best practices.
    • Ensure your changes do not break existing functionality.
    • Write tests if applicable.

  5. Commit Your Changes

    • Add changes to the staging area: 
      git add .
    • Commit your changes with a meaningful message: 
      git commit -m "Description of your changes"

  6. Push to Your Fork

    • Push your branch to your forked repository: 
      git push origin feature/your-feature-name

  7. Create a Pull Request

    • Go to the original repository and click on the “Compare & pull request” button.
    • Provide a clear and detailed description of your changes.
    • Reference any related issues in the pull request description.

3. Code Review Process

  • Your pull request will be reviewed by one or more maintainers.
  • You may be asked to make changes or provide additional information.
  • Once your pull request is approved, it will be merged into the main branch.

4. Documentation

If you are adding a new feature or changing existing functionality, please add informative comments or a docstring to it. This helps other contributors and users understand your changes.