breeze/sockpp
1
0
Fork 0
mirror of https://github.com/fpagliughi/sockpp.git synced 2026-01-12 00:04:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added CONTRIBUTING.md

Browse Source
This commit is contained in:
fpagliughi
2019-09-02 12:13:43 -04:00
parent bdaef9cc47
commit 51de775636
2 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,21 @@
# Contributing to _sockpp_
Thank you for your interest in the _sockpp_ library!
Contributions are accepted and much appreciated. You can contribute updates, bug fixes, and bug reports through the GitHub site for the project.
1. New and unstable development is done in the `develop` branch. Please make all pull requests against the `develop` branch.
1. Please follow the naming and format conventions of the existing code.
1. New features should be zero cost. Existing applications that do not use the feature(s) should not pay a cost in speed or size due to the new additions.
1. Prefer smaller, targeted pull requests (PR's).
1. Put each different new feature in a separate PR.
1. Separate bug fixes and new features in individual PR's.
1. Include unit tests for new features.
1. Please indicate the system, OS, and compiler used for development and whether there are any known incompatibilities with other supported systems.
1. Please only contribute code for which you have legal right to ownership. **Do not** contribute any code written at an employer site or on equipment ownd by an employer, if you have not been given explicit, written consent by the employer to contribute to open-source projects.

6
README.md
View File

@@ -55,6 +55,12 @@ The next release will mainly target bug fixes, API inconsistencies, and numerous
- CMake auto-generates a version header file, _version.h_
- CI dropped tests for gcc-4.9, and added support for clang-7 and 8.
## Contributing
Contributions are accepted and appreciated. New and unstable work is done in the `develop` branch Please submit all pull requests against that branch, not _master_.
For more information, refer to: [CONTRIBUTING.md](https://github.com/fpagliughi/sockpp/blob/master/CONTRIBUTING.md)
## TODO
- **Unit Tests** - The framework for unit and regression tests is in place (using _Catch2_), along with the GitHub Travis CI integration. But the library could use a lot more tests.