From d43f7760866a1a26769dfdebdffebdaf35309f9c Mon Sep 17 00:00:00 2001 From: Aina Niemetz Date: Mon, 22 Apr 2019 16:32:25 -0700 Subject: [PATCH] Add CONTRIBUTING file. (#2968) --- CONTRIBUTING.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 32 +++++++++++++--------------- 2 files changed, 70 insertions(+), 18 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..bbcb077b3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,56 @@ +# Contributing + +CVC4 is distributed under the terms of the modified BSD license (see + [COPYING](https://github.com/CVC4/CVC4/blob/master/COPYING) file). By +submitting a contribution you automatically accept the conditions described in +[COPYING](https://github.com/CVC4/CVC4/blob/master/COPYING). +Additionally, we ask you to certify that you have the right to submit such +contributions. To manage this process we use a mechanism known as [Developer +Certificate of Origin](https://developercertificate.org), which can be +acknowledged by signing-off your commits with `git commit -s`. We require all +pull requests to be squashed into a single commit and signed-off. + +``` +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. +``` + +If you are interested in becoming a long term contributor (for example, a new +decision procedure implementation) to the CVC4 project, please contact one of +the [project leaders](#project_leaders). We'd be happy to point you to some +internal documentation to help you out. diff --git a/README.md b/README.md index 8f38f9004..09f8a0dcc 100644 --- a/README.md +++ b/README.md @@ -56,31 +56,27 @@ We recommend that you visit our CVC4 tutorials online at: for help getting started using CVC4. +If you need help with using CVC4, please refer to +[http://cvc4.stanford.edu/#Technical_Support](http://cvc4.stanford.edu/#Technical_Support). -Contributing -------------------------------------------------------------------------------- +If you are using CVC4 in your work, or incorporating it into software of your +own, we'd like to invite you to leave a description and link to your +project/software on our [Third Party +Applications](http://cvc4.cs.stanford.edu/wiki/Public:Third_Party_Applications). -We are always happy to hear feedback from our users: -* if you need help with using CVC4, please refer to - [http://cvc4.stanford.edu/#Technical_Support](http://cvc4.stanford.edu/#Technical_Support). +Bug Reports +------------------------------------------------------------------------------- -* if you need to report a bug with CVC4, or make a feature request, please - visit our bugtracker at our - [GitHub issues](https://github.com/CVC4/CVC4/issues) page. We are very - grateful for bug reports, as they help us improve CVC4, and patches are - generally reviewed and accepted quickly. +If you need to report a bug with CVC4, or make a feature request, please visit +our bugtracker at our [GitHub issues](https://github.com/CVC4/CVC4/issues) +page. We are very grateful for bug reports, as they help us improve CVC4. -* if you are using CVC4 in your work, or incorporating it into software of your - own, we'd like to invite you to leave a description and link to your - project/software on our [Third Party Applications](http://cvc4.cs.stanford.edu/wiki/Public:Third_Party_Applications). -* if you are interested in contributing code (for example, a new - decision procedure implementation) to the CVC4 project, please - contact one of the [project leaders](#project_leaders). - We'd be happy to point you to some internal documentation to help you out. +Contributing +------------------------------------------------------------------------------- -Thank you for using CVC4! +Please refer to our [contributing guidelines](CONTRIBUTING.md). Project Leaders -- 2.30.2