Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (35 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 2.01 KB
Raw

Contributing to Unity Catalog Pydantic

Thank you for considering contributing to Unity Catalog Pydantic! We welcome contributions from the community and are excited to work with you.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Features

We welcome suggestions for new features. Please open an issue on our GitHub repository and describe the feature you would like to see, along with any relevant use cases.

Submitting Pull Requests

  1. Fork the repository: Click the "Fork" button on the top right of the repository page to create a copy of the repository on your GitHub account.

  2. Clone your fork: Clone your forked repository to your local machine.

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

  3. Create a new branch: Create a new branch for your changes.

    git checkout -b my-feature-branch

  4. Make your changes: Implement your changes in the codebase.

  5. Run tests: Ensure that all tests pass before submitting your pull request.

    pytest

  6. Commit your changes: Commit your changes with a descriptive commit message.

    git commit -am "Add new feature"

  7. Push to your fork: Push your changes to your forked repository.

    git push origin my-feature-branch

  8. Open a pull request: Go to the original repository and open a pull request from your forked repository. Provide a clear description of your changes and any relevant information.

Getting Help

If you need help or have any questions, feel free to open an issue on our GitHub repository.

Thank you for your contributions!