|
| 1 | +# Contributing |
| 2 | + |
| 3 | +:tada:First off, thanks for taking the time to contribute!:tada: |
| 4 | + |
| 5 | +The following is a set of guidelines for contributing to BIThesis. |
| 6 | + |
| 7 | +These are mostly guidelines, not rules. Use your best judgment, |
| 8 | +and feel free to propose changes to this document in a pull request. |
| 9 | + |
| 10 | +## Guidence |
| 11 | + |
| 12 | +**[I don't want to read this whole thing, I just have a small question!!!](#join-our-slack-channel)** |
| 13 | + |
| 14 | +| | For User | For Developer | |
| 15 | +|-----------------|----------|---------------| |
| 16 | +| Have a Question | [Slack](#join-our-slack-channel) | [Slack](#join-our-slack-channel) | |
| 17 | +| Bug Report | [Slack](#join-our-slack-channel) | [Github - Issues](#bug-report-on-github) | |
| 18 | +| Feature Request | [Slack](#join-our-slack-channel) | [Slack](#join-our-slack-channel) | |
| 19 | +| Pull Request | | [Github - Pull Request](#pull-request-process) | |
| 20 | + |
| 21 | +## Join Our Slack Channel |
| 22 | + |
| 23 | +We provide an [offical Slack channel][slack channel invitation] |
| 24 | +with **a bunch of active maintainers** and **a friendly community** |
| 25 | +to give helpful advice **if you have any questions**. |
| 26 | + |
| 27 | +[](https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw) |
| 28 | + |
| 29 | +- use `#community` channel to **report a bug**, **feature request** and **asking for help**. |
| 30 | +- use `#random` channel to have **unrelated discussion**:laughing:! |
| 31 | +- use `#annoucnment` channel if you don't want to miss the **updated news and features**! |
| 32 | + |
| 33 | +> note: there is no detailed rules about how to ask question, just provide enough information and |
| 34 | +rethink before write. |
| 35 | + |
| 36 | +## Bug Report on Github |
| 37 | + |
| 38 | +If you can locate the bug or provide more detailed information, you may |
| 39 | +_[report an issue here][issue reporting link]_. |
| 40 | + |
| 41 | + |
| 42 | +## Pull Request Process |
| 43 | + |
| 44 | +Pull Request are welcomed! |
| 45 | + |
| 46 | +The following steps will help you finish a pull request. |
| 47 | + |
| 48 | +1. fork this repo. |
| 49 | +2. git clone your forked repo. |
| 50 | +3. make small changes until bug fixed. |
| 51 | +4. commit changes. |
| 52 | +5. create a pull request with related information. |
| 53 | +6. keep in touch with further disccusion and refine. |
| 54 | + |
| 55 | +for more information, refer to the |
| 56 | +_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_. |
| 57 | + |
| 58 | +[slack channel invitation]: https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw |
| 59 | +[issue reporting link]: https://github.com/spencerwooo/BIThesis/issues/new |
| 60 | + |
0 commit comments