Contributing to NBoost¶
First of all, thanks for being willing to contribute to NBoost, we love to learn best practice from the community.
Making Commits¶
Contributions are greatly appreciated! You can make corrections or updates and commit them to NBoost. Here are the steps:
- Create a new branch, say
fix-nboost-typo-1 - Fix/improve the codebase
- Commit the changes. Note the commit message must follow the naming style, say
Fix/Model-bert: improve the readability and move sections - Make a pull request. Note the pull request must follow the naming style. It can simply be one of your commit messages, just copy paste it, e.g.
Fix/Model-bert: improve the readability and move sections - Submit your pull request and wait for all checks passed (usually 10 minutes)
- Coding style
- Commit and PR styles check
- All unit tests
- Request reviews from one of the developers from our core team.
- Merge!
Table of Content¶
Commit Message Naming¶
To help everyone with understanding the commit history of NBoost, we employ commitlint in the CI pipeline to enforce the commit styles. Specifically, our convention is:
Type/Scope: subject
where type is one of the following:
- build
- ci
- chore
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
scope is optional, represents the module your commit working on.
subject explains the commit.
As an example, a commit that implements a new encoder should be phrased as:
Fix/Model-bert: improve the readability and move sections
Merging Process¶
A pull request has to meet the following conditions to be merged into master:
- Coding style check (PEP8, via Codacy)
- Commit style check (in CI pipeline via Drone.io)
- Unit tests (via Drone.io)
- Review and approval from a Koursaros team member.