diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e8f55b66..c188c050 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,13 @@ ## Helping to resolve existing issues +There are two main ways you can help the community to resolve existing issues: **Triaging new issues**, and **fixing known bugs**. + +If you have any questions about contributing, or need some help: Feel free to [join the Caxlsx Slack channel](https://join.slack.com/t/caxlsx/shared_invite/enQtOTI5OTM0MzI1Njk5LTBlMDQzNDk2YzkwODMxMmVkODMyYzJiZGU5NTQ3YTg5NTBlN2IwZTlmNTRjNzhiY2E0MDY2OTEyYmFlODI5NjA)! + + +### Triaging new issues + Triaging issues can be very time-consuming, so we especially appreciate any help in this area! Start by looking for (issues labelled “needs triage”)[https://github.com/caxlsx/caxlsx/labels/needs%20triage]. Choose one of these issues, then perform the following checks: @@ -28,6 +35,11 @@ Start by looking for (issues labelled “needs triage”)[https://github.com/cax Add comments to the issue to share your findings. Anything you can do to make bug reports more succinct or easier to reproduce helps folks trying to write code to fix those bugs - whether you end up writing the code yourself or not. +### Fixing known bugs + +Look for [issues labelled “known bug”](https://github.com/caxlsx/caxlsx/labels/known%20bug). Choose one, and try to come up with a fix. + + --- _A lot of the content in this document was ~~inspired by~~ copied from the [Ruby on Rails Contributing Guidelines](https://github.com/rails/rails/blob/master/CONTRIBUTING.md)_ |