CONTRIBUTING.md

Contributing to Solathon

Thank you for your interest in contributing to Solathon! We welcome contributions from the community to help make this project better.

Getting Started

Before you start contributing, please take a moment to review the following guidelines.

Code of Conduct

We expect all contributors to act professionally and respectfully, and we expect our social channels to be a safe and enjoyable environment for all.

How Can I Contribute?

1. Fork the repository and create your branch from master:

   git checkout -b feature/your-feature-branch

2. Make your changes and ensure that they follow the project coding standards.

3. Write tests for your changes to ensure the functionality is correct.

4. Ensure your code passes linting and tests:

   poetry run pytest

5. Commit your changes with a clear and concise commit message:

   git commit -m "Add a brief summary of your changes"

6. Push to your branch:

   git push origin feature/your-feature-branch

7. Create a pull request to the master branch.

Setting Up the Development Environment

To set up your development environment, follow these steps:

1. Install Poetry (if not already installed):

   pip install poetry

2. Clone the repository:

   git clone https://github.com/SuperteamDAO/solathon.git
   cd solathon

3. Install project dependencies:

   poetry install

4. Install development dependencies:

   poetry install --extras=dev

5. Run tests to ensure everything is set up correctly:

   poetry run pytest

Alternatively: In case of any issues with the above steps

1. Create a virtual environment(pip install venv, if you haven't already):

   python -m venv venv

2. Activate Virtual Environment:
   Mac/Linux

   source venv/bin/activate

   Windows

   .\venv\Scripts\activate

3. Install dependencies:

   pip install -r requirements.txt

4. Install dev dependencies:

   pip install -r requirements-dev.txt