Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (33 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

54 lines (33 loc) · 1.17 KB

Contributing to Dictory

Thank you for your interest in contributing to Dictory! Your help is appreciated.

How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of the repository page to create your own copy.

2. Clone Your Fork

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

3. Set Up the Development Environment

Install dependencies:

uv sync --extra dev

4. Make Your Changes

  • Follow PEP8 style guidelines.
  • Write clear, concise commit messages.
  • Add or update tests for your changes.

5. Run Tests

Before submitting, ensure all tests pass:

uv run pytest

6. Submit a Pull Request

  • Push your changes to your fork.
  • Open a pull request against the main branch of the original repository.
  • Describe your changes and reference any related issues.

Code of Conduct

Be respectful and considerate. See Contributor Covenant for guidelines.

Need Help?

Open an issue or ask in the discussions section.

Thank you for contributing!