Contributing

At AlphEast, we believe in the value of the open-source, community-driven approach to developing a healthy software ecosystem. As such, contributions of any kind are highly encouraged and greatly appreciated. Whether you’ve found a bug, have a feature in mind, or see a need for documentation improvements, your input is valuable. We will soon add a roadmap covering the most pressing issues to work on, as well as our long-term goals.

Github Workflow

  1. Fork and fetch the AlphEast repository.

  2. Create a branch for your work with a suggestive name, e.g., feature-add-x.

  3. Make your changes in your branch, keeping commits small and focused. Aim for clear commit messages that explain the “why” behind your changes.

  4. Submit a pull request (PR) to the repository once you’re ready to share your contributions. Describe the changes you’ve made and any additional context that might help the review process.

Get Started Developing

To work on AlphEast, you’ll need to install a newer version of Python. After installation, open a terminal in the root of the repository and create a virtual environment:

python -m venv venv

source venv/bin/activate

Then run:

pip install -e .

This will package the library. You can then run any example project with:

python examples/full/main.py

Create your own example project to experiment with the library.

Style Guides

We aim to maintain a clean and consistent codebase. Detailed style guides will be added soon. In the meantime, please adhere to the following general principles:

  • Follow existing code conventions in the project.

  • Use clear and descriptive names for variables, functions, and classes.

  • Comment your code where necessary to explain complex logic.

Code of Conduct

We are committed to providing a welcoming and inclusive experience for everyone. We expect all participants to adhere to our Code of Conduct. Please read Code of Conduct to understand what behaviors will not be tolerated.

Reporting Bugs or Requesting Features

Bugs

If you encounter a bug, please report it to us by opening an issue. We have a bug report template to help you provide all the necessary information.

  1. Go to the Issues page.

  2. Click on the “New issue” button.

  3. Select the “Bug Report” template.

  4. Fill out the template with as much detail as possible, including steps to reproduce the bug and any error messages or screenshots.

Feature Requests

We welcome suggestions for new features. If there’s something you’d like to see added to AlphEast, please open a new issue.

  1. Go to the Issues page.

  2. Click on the “New issue” button.

  3. Select the “Feature Request” template.

  4. Fill out the template with a clear description of your idea and explain how it would benefit users.

Community and Support

Join us on Slack! It’s a place for discussions, questions, and connecting with other contributors. Whether you need help getting started, have a question about a feature, or want to share ideas, our chat server is the place to be.