Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 1.99 KB

Contributing to Flipper Zero Payloads

Thank you for your interest in contributing to our Flipper Zero payloads repository! We welcome contributions from the community to help make this project better. Please read the following guidelines to make the process smooth and efficient.

How to Contribute

  1. Fork the repository: Click on the "Fork" button at the top right corner of this page to create a copy of this repository in your GitHub account.

  2. Clone your fork: Use git clone to clone your forked repository to your local machine.

    git clone https://github.com/your-username/flipper-zero-payloads.git

  3. Create a new branch: Create a new branch for your changes.

    git checkout -b my-new-feature

  4. Make your changes: Add your payload and necessary documentation. payload.txt: Your payload file. README.md: Documentation explaining the payload, how to use it, and any relevant information.

  5. Commit your changes: Commit your changes with a descriptive message.

    git add .
git commit -m "Add new payload: [payload name]"

  6. Push to your fork: Push your changes to your forked repository.

    git push origin my-new-feature

  7. Submit a pull request: Go to the original repository and open a pull request. Make sure to describe your changes and link to any relevant issues.

Pull Request Requirements

To ensure a smooth review process, please make sure your pull request includes:

  1. payload.txt:
    • The payload file with your script.
  2. README.md:
    • Documentation that includes:
    • Description of the payload.
    • Instructions on how to use the payload.
    • Any prerequisites or dependencies.
    • Examples, if applicable.

Code of Conduct

We follow the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to [email protected]. Thank you for your contributions and for helping to improve the Flipper Zero payloads repository!