Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
53 lines (31 loc) · 1.21 KB

CONTRIBUTING.rst

File metadata and controls

53 lines (31 loc) · 1.21 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Get Started!

Ready to contribute? Here's how to set up serialchemy for local development.

  1. Fork the serialchemy repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_github_username_here/serialchemy.git

  3. Install pixi

    See https://pixi.sh/latest/installation/

  4. Install pre-commit

    $ pixi run setup

  5. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  6. When you're done making changes, run the tests:

    $ pixi run test

  7. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  8. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated.