×

Contributing to Galamo

Thank you for your interest in contributing to Galamo. This document outlines the guidelines and procedures for contributing. We welcome contributions that improve the software, documentation, or overall usability of the package.

---

Types of Contributions

We welcome the following types of contributions:

• Reporting bugs
• Proposing and implementing new features
• Improving documentation and tutorials
• Writing unit tests or enhancing test coverage
• Refactoring or improving existing code

---

Bug Reports

To report a bug, please open an issue on the GitHub Issues page with the following information:

• A clear and descriptive title
• Steps to reproduce the issue
• Expected and actual behavior
• Environment details (operating system, Python version)
• Any relevant error messages or tracebacks

---

Development Environment Setup

To contribute code, please follow these steps:

1. Fork the repository on GitHub.
2. Clone your forked repository:

   git clone https://github.com/your-username/galamo.git
   cd galamo

3. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

4. Install the package in editable mode with development dependencies:

   pip install -e .[dev]

---

Pull Request Procedure

1. Create a new branch for your work:

   git checkout -b feature/my-new-feature

2. Make your changes and commit them with a clear message:

   git commit -m "feat: Add new feature"

3. Push the changes to your fork:

   git push origin feature/my-new-feature

4. Open a pull request (PR) to the `main` branch of the `galamo-org/galamo` repository.
5. In the PR description, explain your changes and link to any relevant issues.

---

Code of Conduct

All contributors are expected to adhere to the project's Code of Conduct. We are committed to providing a welcoming and inclusive environment for everyone. We appreciate your efforts to improve Galamo!