Skip to content

Contribution

JuniorAlive edited this page Aug 10, 2024 · 1 revision

Contribute 🌟

Thank you for considering contributing to SPYCLI! Contributions are what make the open-source community an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. πŸ™

How to Contribute

There are many ways to contribute to the SPYCLI project, from writing code πŸ–₯️ and fixing bugs πŸ› to improving documentation πŸ“„ and providing feedback πŸ’¬.

Reporting Bugs 🐞

  1. Use the GitHub Issues page: Navigate to the SPYCLI Issues page and check if the bug has already been reported.
  2. Create a new issue: If you are the first to notice the bug, open a new issue. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements ✨

  1. Submit an issue: Detail the suggestion in an issue on GitHub. Describe how this enhancement would be beneficial to SPYCLI and potentially other users.

Pull Requests πŸ”

  1. Fork the Project: Fork the repository and create your feature branch (git checkout -b feature/AmazingFeature).
  2. Make your changes: Update the code with your new feature or fix.
  3. Commit your Changes: Commit your changes using a clear and descriptive commit message (git commit -m 'Add some AmazingFeature').
  4. Push to the Branch: Push your changes to your fork (git push origin feature/AmazingFeature).
  5. Open a Pull Request: Go to the original SPYCLI repository and open a pull request with a comprehensive list of changes and a link to the relevant issue if applicable.

Guidelines πŸ“

Please adhere to the following guidelines when contributing:

  • Ensure your coding style matches the existing code base. πŸ“š
  • Update the README.md with details of changes to the interface, including new environment variables, exposed ports, useful file locations, and container parameters. πŸ› οΈ
  • Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

Community 🀝

  • Join the Discussion: Become a part of the SPYCLI community. Join our Discord Server to meet other contributors and discuss development, bugs, features, and more.
  • Stay Informed: Keep up with the latest developments and have a say in the future direction of SPYCLI. πŸ“ˆ

Acknowledgments πŸŽ‰

Contributions, large and small, make a significant impact on maintaining and improving open-source projects like SPYCLI. We appreciate your efforts and are excited to see what you bring to the community! ❀️