ibis-project / ibis-bigquery

BigQuery backend for Ibis
Apache License 2.0
19 stars 18 forks source link

document CONTRIBUTING steps #53

Open tswast opened 3 years ago

tswast commented 3 years ago

We're using "conventional commits" and "release-please" to manage the CHANGELOG here, so commit subjects and PR titles need to be user-facing

Some notes I've written from another project that may be useful to include:

Conventional Commits

This project uses Conventional Commits to manage the CHANGELOG and releases.

Allowed commit prefixes are defined in the release-please source code:

User-facing commits

Hidden commits (not shown in CHANGELOG)

loudinb commented 3 years ago

@tswast I am trying to work on contribution instructions, but I realize that I may not have it straight.

For ibis_bigquery it appears that flake8, mypy and isort are being used for static code analysis, but you are not using black, is this correct?

The setup.cfg for ibis_bigquery is fairly sparse, there are no configurations for any of the static analysis. Should the settings from the setup.cfg found in the main ibis project be used?

tswast commented 3 years ago

You're right. Not sure why we didn't add black to the GitHub Actions.

Other than the conventional commits convention, I agree that we should align with the main ibis project. It'd be nice to copy over the pre-commit-config.yml and related instructions as well.