Skip to content

Commit

Permalink
clean up contribute.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rodrigo-ceccato committed Nov 7, 2024
1 parent c4ad74e commit a15f7be
Showing 1 changed file with 0 additions and 27 deletions.
27 changes: 0 additions & 27 deletions docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,6 @@

Welcome to the Spinner project! This guide will help you set up your development environment, understand our linting policies, learn how to use Git tags for versioning, and understand how our build automation works.

## Table of Contents

- [Setting Up the Development Environment](#setting-up-the-development-environment)
- [Mandatory Lint Policy](#mandatory-lint-policy)
- [Versioning with Git Tags](#versioning-with-git-tags)
- [Using Git Tags](#using-git-tags)
- [Best Practices for Tagging](#best-practices-for-tagging)
- [Build Automation with GitHub Actions](#build-automation-with-github-actions)
- [How the Build Bot Works](#how-the-build-bot-works)
- [Configuring PyPI Credentials](#configuring-pypi-credentials)
- [Versioning with `setuptools_scm`](#versioning-with-setuptools_scm)
- [Conclusion](#conclusion)

## Setting Up the Development Environment

To set up your development environment for Spinner, follow these steps:
Expand Down Expand Up @@ -202,13 +189,6 @@ Our project uses GitHub Actions to automate the build and deployment process. Wh
- **PyPI API Token**: The API token for PyPI is stored securely in GitHub Secrets under the name `PYPI_API_TOKEN`.
- **Security**: Never commit API tokens or passwords to the repository.

### Versioning with `setuptools_scm`

We use `setuptools_scm` to automatically manage the package version based on Git tags.

- **Dynamic Versioning**: The version number is derived from the latest Git tag.
- **Configuration**: Ensure `pyproject.toml` is set up correctly with `dynamic = ["version"]` and includes `setuptools_scm` in the build requirements.

### Important Notes

- **Ensure Tags are Pushed**: The build bot relies on the Git tags to determine the version. Always push your tags to GitHub.
Expand All @@ -218,13 +198,6 @@ We use `setuptools_scm` to automatically manage the package version based on Git
```sh
python -m build
```

## Conclusion

By following these guidelines, you can contribute effectively to the Spinner project. Our versioning and build automation processes ensure that releases are consistent and that our package is reliably published to PyPI.

If you have any questions or need assistance, feel free to reach out to the maintainers.

---

Happy coding!

0 comments on commit a15f7be

Please sign in to comment.