Skip to content

Latest commit

 

History

History
executable file
·
64 lines (48 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
64 lines (48 loc) · 2.83 KB

Contributing to Boot Image Flasher

When contributing to this repository, please first discuss the change you wish to make with the owner of this repository via Telegram. Your help is greatly appreciated. Below are some guidelines to help you get started.

Table of Contents

How Can I Contribute?

Reporting Bugs

If you encounter any bugs, please help us improve Boot Image Flasher by reporting them. Before creating a bug report, please check if an existing issue already addresses your concern.

To report a bug:

  1. Open an issue on the GitHub Issues page.
  2. Select the bug report template.
  3. Read the instructions carefully and fill out the template with as much detail as possible.
  4. Submit the issue and wait for support.

Suggesting Enhancements

We welcome suggestions for new features or improvements. To suggest an enhancement:

  1. Open an issue on the GitHub Issues page.
  2. Provide a clear and descriptive title.
  3. Describe the enhancement in detail.
  4. Explain why this enhancement would be useful.
  5. Include any relevant examples or code snippets if applicable.

Submitting Pull Requests

Pull requests are welcome! To submit a pull request:

  1. Fork the repository.
  2. Create a new branch from Master.
  3. Make your changes and ensure they adhere to the Code Style guidelines.
  4. Test your changes thoroughly.
  5. Commit your changes with a descriptive commit message.
  6. Push your branch to your forked repository.
  7. Open a pull request to the Master branch of the main repository.
  8. Provide a clear and descriptive title and description of your changes.
  9. Reference any related issues.

Your pull request will be reviewed, and feedback will be provided. Please be responsive to any requested changes or questions.

Code Style

To maintain code consistency and readability, please follow these guidelines:

  1. Use clear and descriptive variable and function names.
  2. Follow the existing code structure and commenting style.
  3. Test your code changes thoroughly.
  4. Ensure your code adheres to the project’s formatting conventions.

Community Guidelines

  1. Be respectful and considerate in all interactions.
  2. Provide constructive feedback and help others when possible.
  3. Follow the Code of Conduct to maintain a positive and inclusive community.

Thank you for contributing to Boot Image Flasher! Your efforts help make this project better for everyone 😉.