Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

63 lines (37 loc) · 2.71 KB
Raw

Contribution Guidelines

👋 Welcome to the Simplex Bot open-source community! We appreciate your interest in contributing to our project. By contributing, you help make our project better and more robust.

Before you get started, please take a moment to review our contribution guidelines to ensure a smooth and effective collaboration.

How to Contribute

We welcome contributions in the form of bug reports, feature requests, code contributions, documentation improvements, and more. Here's how you can contribute:

Bug Reports and Feature Requests

If you find a bug or have a feature request, please open an issue on our GitHub repository. Be sure to include relevant details like steps to reproduce the issue or a clear description of the new feature you're proposing.

Code Contributions

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine.

    git clone https://github.com/micfun123/Simplex_bot.git

  3. Create a new branch for your feature or bug fix.

    git checkout -b feature-name

  4. Make your changes and commit them with a clear and concise commit message.

    git add .
git commit -m "Add a brief description of your changes"

  5. Minimize New Dependencies: If your changes require the addition of new dependencies, please keep them to a minimum. New dependencies must be justified in the pull request description. Add the new dependencies to the requirements.txt file.

  6. Push your changes to your forked repository.

    git push origin feature-name

  7. Open a pull request on the original repository with a detailed description of your changes, including justification for any new dependencies added.

Coding Standards

Please follow the coding standards and conventions used in the project. If there are specific guidelines, they will be mentioned in the project's documentation or in relevant source code files.

Testing

Before submitting a pull request, make sure that your changes pass any existing tests. If the project doesn't have tests, consider adding them to cover your changes.

Code of Conduct

Please note that by participating in this project, you agree to abide by our Code of Conduct. We expect all contributors to be respectful and considerate.

Get in Touch

If you have any questions, concerns, or just want to say hi, feel free to reach out to us on our Discord channel or via email.

Thank you for contributing to Simplex Bot! 🚀