Skip to content

Files

Latest commit

 

History

History
94 lines (66 loc) · 4.08 KB

CONTRIBUTING.md

File metadata and controls

94 lines (66 loc) · 4.08 KB

Contributing to ShellKill 🚀

First of all, thank you for considering contributing to ShellKill! 🎉 This project is open-source, and your contributions are what make it better for everyone. Please follow the guidelines below to make the contribution process smooth and effective.

How to Contribute 🤝

1. Fork the repository 🍴

  • Start by forking the project to your own GitHub account. This allows you to freely make changes without affecting the original project.

  • Fork the ShellKill repo here

2. Clone your fork 👩‍💻

  • Clone your fork to your local machine: 
    git clone https://github.com/YOUR_USERNAME/ShellKill.git

3. Create a feature branch 🌱

  • Create a branch for your changes. Name it according to the feature you're working on. 
    git checkout -b feature/your-feature-name

4. Make your changes 🛠️

  • Implement the changes or bug fixes.
  • Be sure to follow the existing code style and structure.

5. Run tests 🧪

  • If you added new functionality, be sure to add tests for it in the tests/ folder.
  • Ensure all tests pass by running: 
    python -m unittest discover tests/

6. Commit your changes ✍️

  • Make sure your commit messages are clear and follow the Conventional Commits style.
  • Example commit message: 
    feat: add evasion techniques for bypassing upload restrictions

7. Push your changes ⬆️

  • Push the changes back to your forked repository: 
    git push origin feature/your-feature-name

8. Create a Pull Request 📑

  • Once your changes are pushed, go to the original repository and create a Pull Request (PR).
  • Include a clear description of what your PR does, what issue it addresses (if applicable), and any extra context that may help.

Pull Request Guidelines 📋

  • Make small, focused changes: Ensure that your PR only addresses one feature or bug fix. This makes it easier for maintainers to review and merge your contribution.
  • Write clear commit messages: Your commit messages should describe the changes made, the problem being solved, or the feature being added.
  • Keep PR descriptions detailed: When submitting a PR, provide detailed information about what was changed and why. If you're fixing a bug or addressing an issue, reference the issue number (e.g., Fixes #5).
  • Follow the coding style: Use the existing code style and structure. If you're adding new functionality, ensure it aligns with the current design.
  • Add tests: If you're adding new functionality or fixing a bug, add tests to ensure the changes are correct and prevent regressions.

Reporting Bugs or Issues 🐛

If you find a bug or issue, please follow these steps:

  1. Check if the issue has already been reported: Browse through the existing issues to see if someone has already reported it.
  2. Create a detailed issue: If the bug hasn't been reported, create a new issue with a descriptive title and detailed information, including:
    • Steps to reproduce the issue
    • Expected and actual behavior
    • Any relevant logs or screenshots
    • Environment details (e.g., Python version, OS)

Code of Conduct 🧑‍🤝‍🧑

By contributing to ShellKill, you agree to follow the project's Code of Conduct, which promotes a welcoming and respectful environment for all contributors.

Getting Help 🙋‍♂️

If you're having trouble contributing or need help understanding the code, feel free to:

  • Open an issue: If you're unsure about how to implement something or need guidance, you can ask in an issue.
  • Join discussions: You can also join the discussions around the project for guidance.

Thank You for Contributing! 🎉

Your contribution helps make ShellKill even better. Together, we can make this tool more powerful, useful, and enjoyable for everyone! 🚀