Skip to content

Latest commit

 

History

History
83 lines (48 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

83 lines (48 loc) · 2.23 KB

Contributing to Crypto Comparison Project

Thank you for your interest in contributing to our project! We welcome contributions from the community and aim to make the process as smooth and transparent as possible.

How to Contribute

Reporting Issues

If you find any bugs or have suggestions for improvements, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue and any relevant information.

Submitting Pull Requests

To contribute code, please follow these steps:

  1. Fork the Repository

    Fork the repository to your own GitHub account.

  2. Clone the Forked Repository

    git clone https://github.com/dkrizhanovskyi/crypto-comparison.git
cd crypto-comparison

  3. Create a New Branch

    Create a new branch for your feature or bug fix.

    git checkout -b feature-name

  4. Make Your Changes

    Make your changes in the new branch. Ensure your code follows the project's coding standards.

  5. Commit Your Changes

    Commit your changes with a clear and descriptive commit message.

    git add .
git commit -m "Description of your changes"

  6. Push to Your Fork

    Push your changes to your forked repository.

    git push origin feature-name

  7. Submit a Pull Request

    Open a pull request from your fork to the main repository. Provide a clear description of your changes and any relevant information.

Coding Standards

Please adhere to the following coding standards:

  • Python: Follow PEP 8 guidelines. Use linters such as flake8 to ensure code quality.
  • Documentation: Ensure all functions and classes are well-documented. Use docstrings to describe the purpose and usage of your code.

Testing

Ensure that your code is well-tested. Add unit tests for any new functionality and run all tests to ensure nothing is broken.

python -m unittest discover

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please treat others with respect and kindness.

Getting Help

If you have any questions or need help, feel free to open an issue or contact the project maintainers.

Thank you for your contributions!