Open tswast opened 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?
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.
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
feat:
section: 'Features'fix:
section: 'Bug Fixes'perf:
section: 'Performance Improvements'deps:
section: 'Dependencies'revert:
section: 'Reverts'docs:
section: 'Documentation'Hidden commits (not shown in CHANGELOG)
style:
section: 'Styles', hidden: truechore:
section: 'Miscellaneous Chores', hidden: truerefactor:
section: 'Code Refactoring', hidden: truetest:
section: 'Tests', hidden: truebuild:
section: 'Build System', hidden: trueci:
section: 'Continuous Integration', hidden: true