Skip to content

Latest commit

 

History

History
executable file
·
107 lines (76 loc) · 5.91 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
107 lines (76 loc) · 5.91 KB

Contributing to Boot Image Extractor

First off, thanks for taking the time to contribute! ❤️

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.

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

How Can I Contribute?

Reporting Bugs

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

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side (e.g., using incompatible environment components/versions). Make sure that you have read the documentation. If you are looking for support, you might want to check this section.
  • To see if other users have experienced (and potentially already solved) the same issue, check if there is an existing bug report for your issue in the bug tracker.
  • Search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform, and Version (Windows, Linux, macOS, x86, ARM)
    • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

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

Enhancement suggestions are tracked as GitHub issues.

  1. Open an issue on the GitHub Issues page.
  2. Use a clear and descriptive title for the issue to identify the suggestion.
  3. Provide a step-by-step description of the suggested enhancement in as many details as possible.
  4. Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
  5. Explain why this enhancement would be useful to most Boot Image Extractor users. You may also want to point out other projects that solved it better and which could serve as inspiration.
  6. Include any relevant examples or code snippets if applicable.

Submitting Pull Requests

To make a code contribution, follow these steps:

  1. Fork the Repository: Fork the repository by clicking the "Fork" button at the top right of the repository page.

  2. Create a Branch: Create a new branch for your work:

    git checkout -b your-branch-name

  3. Make Changes: Make your changes to the code. Ensure your changes adhere to the project's code style.

  4. Commit Your Changes: Commit your changes with a clear and concise message:

    git commit -m "Description of the changes made"

  5. Push to the Branch: Push your changes to your forked repository:

    git push origin your-branch-name

  6. Submit a Pull Request: Go to the original repository and create a pull request from your forked repository. Include a clear title and description of your changes.

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

Code Style

  • Follow PEP 8 for Python code style.
  • Use meaningful variable names.
  • Write docstrings for all functions and classes.
  • Ensure your code is well-documented and readable.
  • Format your code using tools like black or flake8 to maintain consistency.

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.

Contact

If you have any questions or need further assistance, please contact the repository owner via Telegram.

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