Skip to content

Latest commit

 

History

History
executable file
·
62 lines (41 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
62 lines (41 loc) · 2.25 KB
Raw

Contributing to FrostWing

Thank you for your interest in contributing to FrostWing! We welcome contributions from the community to help make this project even more awesome. Please take a moment to review the following guidelines before getting started.

How to Contribute

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine.

    git clone https://github.com/pradosh-arduino/FrostWing.git
cd FrostWing

  3. Create a new branch for your contribution.

git checkout -b feature/your-feature

  1. Make your changes, fix bugs, or add new features.

  2. Test your changes to ensure they work as expected.

  3. Commit your changes.

git commit -m "Add your commit message here"
  1. Push your changes to your fork on GitHub.
git push origin feature/your-feature
  1. Create a pull request (PR) to the main branch of the main repository. Be sure to provide a clear and descriptive title and description for your PR.

Code Guidelines

  • Follow the coding style and conventions used in the existing codebase.

  • Ensure your code is well-documented to help others understand your changes.

  • Write clear and concise commit messages.

  • Do not use plain inline assembly in C source file, create a function check the kernel architecture and run instructions based on it

Issues and Bug Reports

If you find a bug or want to propose an enhancement, please open an issue on the GitHub issue tracker. When reporting a bug, include as much detail as possible, such as the steps to reproduce, expected behavior, and the actual behavior.

Code of Conduct

We expect all contributors to adhere to the following guidelines:

  • Be respectful and considerate of others' viewpoints and experiences.
  • Create an inclusive and welcoming environment for all participants.
  • Avoid any form of discrimination, harassment, or offensive behavior.
  • Respect others' privacy and personal boundaries.
  • Handle conflicts and disagreements professionally and constructively.

If you witness or experience any behavior that violates these guidelines, please report it to the project maintainers at [pradoshgame@gmail.com].

Let's work together to create a positive and inclusive community for FrostWing.

Thank you for your cooperation.