Skip to content

Commit 3f89279

Browse files
author
Daniel Kroening
authored
Merge pull request #1270 from peterschrammel/contribute-readme
Contributing section in readme
2 parents a44b369 + 11be8f6 commit 3f89279

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,31 @@ and passing the resulting equation to a decision procedure.
1515

1616
For full information see [cprover.org](http://www.cprover.org/cbmc).
1717

18+
Versions
19+
========
20+
21+
Get the [latest release](https://github.com/diffblue/cbmc/releases)
22+
* Releases are tested and for production use.
23+
24+
Get the current *develop* version: `git clone https://github.com/diffblue/cbmc.git`
25+
* Develop versions are not recommended for production use.
26+
27+
Report bugs
28+
===========
29+
30+
If you encounter a problem please file a bug report:
31+
* Create an [issue](https://github.com/diffblue/cbmc/issues)
32+
33+
Contributing to the code base
34+
=============================
35+
36+
1. Fork the repository
37+
2. Clone the repository `git clone [email protected]:YOURNAME/cbmc.git`
38+
3. Create a branch from the `develop` branch (default branch)
39+
4. Make your changes (follow the [coding guidelines](https://github.com/diffblue/cbmc/blob/develop/CODING_STANDARD.md))
40+
5. Push your changes to your branch
41+
6. Create a Pull Request targeting the `develop` branch
42+
1843
License
1944
=======
2045
4-clause BSD license, see `LICENSE` file.

0 commit comments

Comments
 (0)