Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.16 KB

Contributing to AlphaFind

We welcome contributions to AlphaFind! This document outlines the process for contributing to this project.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: git clone https://github.com/your-username/AlphaFind.git
  3. Create a new branch for your feature or bug fix: git checkout -b your-feature-name

Making Changes

  1. Make your changes in your feature branch.
  2. Add or update tests as necessary.
  3. Ensure all tests pass.
  4. Update documentation if required.

Submitting Changes

  1. Push your changes to your fork on GitHub.
  2. Submit a pull request to the main AlphaFind repository.
  3. Describe your changes in detail in the pull request description.

Code Style

  • Follow the existing code style in the project.
  • Use meaningful variable and function names.
  • Comment your code where necessary.

Reporting Issues

  • Use the GitHub issue tracker to report bugs or suggest features.
  • Provide as much detail as possible, including steps to reproduce for bugs.

Community

  • Be respectful and considerate in all interactions.
  • Help others who have questions.

Thank you for contributing to AlphaFind!