Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (55 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

75 lines (55 loc) · 2.44 KB
Raw

Contributing to OpenESC

First off, thanks for taking the time to contribute! 🚀
This document outlines the guidelines for contributing to the OpenESC project.

How Can You Contribute?

  1. Reporting Bugs:
    If you find any bugs or issues, please report them by creating a new issue on GitHub.

  2. Suggesting Enhancements:
    Have an idea to improve the project? Feel free to open a new issue with your suggestion.

  3. Fixing Issues:
    Found an open issue that you'd like to fix? Feel free to submit a pull request (PR) with your solution.

  4. Improving Documentation:
    You can help by improving the documentation, fixing typos, or clarifying instructions.

Getting Started

  1. Fork the repository.

  2. Clone your fork locally.

    git clone https://github.com/sidharthmohannair/OpenESC.git
cd OpenESC

  3. Create a new branch for your work.

    git checkout -b your-branch-name

  4. Make your changes and commit them.

    git add .
git commit -m "Your detailed description of changes."

  5. Push your branch to GitHub.

    git push origin your-branch-name

  6. Open a pull request (PR) on the main repository and fill out the provided PR template.

Code of Conduct

Please adhere to the Code of Conduct in all interactions.

Coding Standards

  • Coding Style: Follow the Google C++ Style Guide.
  • Unit Tests: Ensure that all new functionality is tested. If you're adding new features, include tests to validate them.
  • Commit Messages: Write clear and concise commit messages.

Reporting Bugs

If you find a bug, please report it by following these steps:

  • Check the existing issues to ensure the bug hasn't been reported yet.
  • If not, open a new issue and include as much detail as possible:
    • The version of OpenESC you're using.
    • Detailed description of the problem.
    • Steps to reproduce the issue.
    • Any relevant logs, error messages, or screenshots.

Pull Request Process

  1. Ensure the code compiles and works correctly.
  2. Keep pull requests small and focused.
  3. Write a clear PR title and description, linking to the issue you're solving if applicable.
  4. Submit the pull request for review.
  5. Respond to any feedback or requests for changes.

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.