• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Contributing to Beast
2
3Thank you for taking the time to read this document!
4
5:heart_eyes: **please star the Boost.Beast repository!** :heart_eyes:
6
7First make sure you're on the
8[official repository page](https://github.com/boostorg/beast/blob/master/CONTRIBUTING.md),
9then just press the button labeled "star" in the top right of the page
10to give Beast a star! Your stars create generate additional visibility,
11which leads to more users, more bug reports, more fixes, more testing,
12more features, and a better product!
13
14<a href="https://github.com/boostorg/beast/blob/master/CONTRIBUTING.md">
15<img width="400" height = "150" alt = "Please Star the Repository"
16    src="https://raw.githubusercontent.com/vinniefalco/BeastAssets/master/StarTheRepo.png">
17</a>
18
19Click the image above to make sure you're on the official
20Boost repository page so you can give Beast a star!
21
22# Ways to Contribute
23
24No contribution to Beast is too big or too small! We are
25always happy to see user participation in all of its forms.
26Here are some of the ways that you can contribute (this is
27by no means an exhaustive list):
28
29* Submit a
30  [bug report](https://github.com/boostorg/beast/issues).
31  We love hearing about broken things, so
32  that we can fix them. Any problem is fair game, this includes
33  the documentation examples, tests, and repository as well as the
34  library itself. Bug reports should be opened on the
35  [Issues](https://github.com/boostorg/beast/issues) page.
36
37* Provide
38  [feedback](https://github.com/boostorg/beast/issues).
39  about the library. If you have used, are using,
40  or are thinking about using the library we want to hear about it!
41  The more information you provide, the better we will be able
42  to ensure that Beast meets your needs. You can provide feedback
43  as an issue, or email the author directly.
44
45* Test Beast. When changes are made, they are submitted as a
46  [Pull Request](https://github.com/boostorg/beast/pulls).
47  Everyone is welcome to examine these upcoming changes, test them,
48  and report on the results. This form of quality assurance is very
49  helpful so we can keep delivering a great product. Consider
50  subscribing to repository notifications to get alerted to new
51  pull requests.
52
53* Code Review on
54  [Pull Requests](https://github.com/boostorg/beast/pulls).
55  This is one of the most valuable ways to contribute, because it helps
56  to improve code and features, and helps to find bugs, before the code
57  gets merged. A little bit of time investment from just a few people on
58  each pull request goes a **long** way to increasing the quality of the
59  final product. For tips on how to participate in pull requests please
60  view the
61  [README.md](https://github.com/boostorg/beast#contributing-we-need-your-help).
62
63* Use Beast in your next application! At the end of the day, it is the
64  goal of the library to provide utility to users so the best way you
65  can contribute is simply to use the library!
66