The following provides a set of guidelines for contributing to the WhileyCompiler.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.
This project is licensed under the Apache 2.0 license. such As, you must adhere to this license when working with this project. This project employs a Copyright Licensing Agreement, whereby copyright is retained by contributors:
"In a Contributor License Agreement (CLA), the original contributor retains copyright ownership of their contributions, but grants the project a broad set of rights such that the project can incorporate and distribute the contributions as it needs to"
(from opensource.org)
The WhileyCompiler is part of the
Whiley Compiler Collection.
This is the overarching framework which brings together components for
compiling, verifying, testing and documenting Whiley programs (and
much more). The WhileyCompiler compiler can be thought of as a
"plugin" within this framework.
Reporting bugs is a useful and rewarding way of contributing. Please use the issue tracker and try, as much as possible, to provide minimal examples which illustrate the problem along with a clear description of what happened.
You are welcome to make pull requests to this project. Small pull requests are likely to be accepted quickly. Large pull requests may involve further discussion and peer review.
Please do not include lines such as the following on the files you modify:
// Copyright (c) 2011, David J. Pearce (dave@blah.com)
Such lines are tedious to manage and unnecessary. The commit history of the project is sufficient evidence of your contribution.
In making a contribution to the WhileyCompiler compiler, you
implicitly certify that:
(a) The contribution was created in whole or in part by you and you have the right to submit it under the open source license indicated; or
(b) The contribution is based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, under the same open source license (unless you are permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to you by some other person who certified (a), (b) or (c) and you have not modified it.
(d) You understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information you submit with it) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.