Adding contribution guideline - Githubissues

cdpierse / transformers-interpret

Model explainability that works seamlessly with 🤗 transformers. Explain your transformers model in just 2 lines of code.

Apache License 2.0

1.29k stars 97 forks source link

Adding contribution guideline #42

Closed lalitpagaria closed 3 years ago

lalitpagaria commented 3 years ago

@cdpierse While contributing one PR to this awesome repo, I observed that it would be great to have contribution guideline.

Some of possible points can be added to this guide are -

Fork the repo [If not done]
Fetch upstream (git fetch upstream)
Checkout dev branch
Rebase dev branch with upstream (git rebase upstream/dev)
Create new branch and add changes to that branch
Add/update/remove relevant test cases
Perform black formatting on changes
Raise PR against upstream dev branch
Ask for the review

Few observations about CI process -

CI should run on every PR, so PR raiser will get feedback about test failure or build issue early
Currently PR merge is very open, it does not check for PR approval and CI pass status

cdpierse commented 3 years ago

@lalitpagaria this is definitely a top priority, will hopefully be able to dedicate the weekend to getting a decent and thorough guide out.