forked from boostorg/beast
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README, add CONTRIBUTING.md and CODE_OF_CONDUCT.md
- Loading branch information
1 parent
3cba28f
commit e1495e4
Showing
5 changed files
with
89 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,16 @@ | ||
PLEASE DON'T FORGET TO "STAR" THIS REPOSITORY :) | ||
|
||
If you rather keep your project secret, feel free | ||
to email the author at `<[email protected]>`; any | ||
private correspondence is treated as confidential. | ||
|
||
When reporting a bug please include the following: | ||
|
||
### Version of Beast | ||
|
||
You can find the version number in <beast/version.hpp> | ||
or using the command "git log -1". | ||
You can find the version number in the file `<boost/beast/version.hpp>`, | ||
or by using the command "git log -1" in the local Beast repository | ||
directory. | ||
|
||
### Steps necessary to reproduce the problem | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Code of Conduct | ||
|
||
* Be respectful of others | ||
|
||
* Please use professional conduct | ||
|
||
* Treat others the way you want to be treated | ||
|
||
Thank you! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Contributing to Beast | ||
|
||
Thank you for taking the time to read this document! | ||
|
||
:heart_eyes: **please star the Boost.Beast repository!** :heart_eyes: | ||
|
||
First make sure you're on the | ||
[official repository page](https://github.com/boostorg/beast/blob/master/CONTRIBUTING.md), | ||
then just press the button labeled "star" in the top right of the page | ||
to give Beast a star! Your stars create generate additional visibility, | ||
which leads to more users, more bug reports, more fixes, more testing, | ||
more features, and a better product! | ||
|
||
<a href="https://github.com/boostorg/beast/blob/master/CONTRIBUTING.md),"> | ||
<img width="400" height = "150" alt = "Please Star the Repository" | ||
src="https://raw.githubusercontent.com/vinniefalco/BeastAssets/master/StarTheRepo.png"> | ||
</a> | ||
|
||
Click the image above to make sure you're on the official | ||
Boost repository page so you can give Beast a star! | ||
|
||
# Ways to Contribute | ||
|
||
No contribution to Beast is too big or too small! We are | ||
always happy to see user participation in all of its forms. | ||
Here are some of the ways that you can contribute (this is | ||
by no means an exhaustive list): | ||
|
||
* Submit a | ||
[bug report](https://github.com/boostorg/beast/issues). | ||
We love hearing about broken things, so | ||
that we can fix them. Any problem is fair game, this includes | ||
the documentation examples, tests, and repository as well as the | ||
library itself. Bug reports should be opened on the | ||
[Issues](https://github.com/boostorg/beast/issues) page. | ||
|
||
* Provide | ||
[feedback](https://github.com/boostorg/beast/issues). | ||
about the library. If you have used, are using, | ||
or are thinking about using the library we want to hear about it! | ||
The more information you provide, the better we will be able | ||
to ensure that Beast meets your needs. You can provide feedback | ||
as an issue, or email the author directly. | ||
|
||
* Test Beast. When changes are made, they are submitted as a | ||
[Pull Request](https://github.com/boostorg/beast/pulls). | ||
Everyone is welcome to examine these upcoming changes, test them, | ||
and report on the results. This form of quality assurance is very | ||
helpful so we can keep delivering a great product. Consider | ||
subscribing to repository notifications to get alerted to new | ||
pull requests. | ||
|
||
* Code Review on | ||
[Pull Requests](https://github.com/boostorg/beast/pulls). | ||
This is one of the most valuable ways to contribute, because it helps | ||
to improve code and features, and helps to find bugs, before the code | ||
gets merged. A little bit of time investment from just a few people on | ||
each pull request goes a **long** way to increasing the quality of the | ||
final product. For tips on how to participate in pull requests please | ||
view the | ||
[README.md](https://github.com/boostorg/beast#contributing-we-need-your-help). | ||
|
||
* Use Beast in your next application! At the end of the day, it is the | ||
goal of the library to provide utility to users so the best way you | ||
can contribute is simply to use the library! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters