Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (51 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

65 lines (51 loc) · 2.2 KB

Contributing to Easy Embedded Framework

Thank you for your interest in contributing to Easy Embedded Framework! We welcome all kinds of contributions, including bug reports, feature requests, documentation improvements, and code contributions.

How to Contribute

1. Fork the Repository

  • Click the "Fork" button at the top right of the repository page.
  • Clone your fork to your local machine: 
    git clone https://github.com/your-username/EasyEmbeddedFramework.git

2. Create a Branch

  • Create a new branch for your feature or bugfix: 
    git checkout -b my-feature-branch

3. Make Your Changes

  • Make your changes in the appropriate files.
  • Add tests for new features or bug fixes when possible.
  • Ensure your code follows the project's style and passes all tests.

4. Commit and Push

  • Commit your changes with a clear message: 
    git add .
git commit -m "Describe your change"
git push origin my-feature-branch

5. Open a Pull Request

  • Go to the original repository on GitHub.
  • Click "Compare & pull request" next to your branch.
  • Fill in the PR template, describing your changes and why they are needed.
  • Link any related issues.

Code Style

  • Follow the existing code style and conventions.
  • Use descriptive variable and function names.
  • Document new functions, classes, and modules.

Reporting Issues

  • Use GitHub Issues to report bugs or request features.
  • Provide as much detail as possible, including steps to reproduce, expected behavior, and screenshots/logs if applicable.

Pull Request Guidelines

  • One feature or bugfix per pull request.
  • Keep pull requests focused and concise.
  • Reference related issues in your PR description (e.g., "Closes #123").
  • Ensure all tests pass before submitting.
  • Be responsive to feedback and requested changes.

Community Standards

  • Be respectful and inclusive.
  • Use welcoming and constructive language.
  • See the Code of Conduct if available.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for helping make Easy Embedded Framework better!