CONTRIBUTING.md 6.05 KB
Newer Older
1
2
3
Contributing to Frama-C
=======================

4
5
6
7
8
9
10
11
12
13
14
15
16
We always welcome technical as well as non-technical contributions from the
community.
There are several ways to participate in the Frama-C project:

- Asking questions and discussing at
  [StackOverflow](https://stackoverflow.com/tags/frama-c) and through
  the
  [Frama-C-discuss mailing list](https://lists.gforge.inria.fr/mailman/listinfo/frama-c-discuss);

- Reporting bugs (via
  [Github issues](https://github.com/Frama-C/Frama-C-snapshot/issues)) or the
  [Mantis BTS](https://bts.frama-c.com);

Thibaud Antignac's avatar
Thibaud Antignac committed
17
- [Submitting bug fixes, improvements, and features](#submitting-bug-fixes-improvements-and-features)
18
19
  via Github pull requests;

Thibaud Antignac's avatar
Thibaud Antignac committed
20
- [Developing external plug-ins](#developing-external-plug-ins)
21
22
23
24
25
26
27
28
29
  and sharing it with us through a Github pull request;

- Joining the [Frama-C team](http://frama-c.com/about.html) (as an intern, a PhD
  student, a postdoctoral researcher, or a research engineer).

We give below some guidelines in order to ease the submission of a pull request
and optimize its integration with the Frama-C existing codebase.


Thibaud Antignac's avatar
Thibaud Antignac committed
30
31
Submitting bug fixes, improvements, and features
================================================
32
33
34
35
36
37
38
39
40
41
42
43

Main Frama-C development happens outside Github. By default, patches and
improvements are applied upstream and only release candidates and stable
releases are pushed to Github.

Therefore, your pull requests will not be directly merged in the `master` branch
on Github. Instead, we will port them in our internal development platform and
they will be available on Github after the next Frama-C release incorporates
them.

To fit this workflow, we recommend to:

44
1. [Open an issue](https://github.com/Frama-C/Frama-C-snapshot/issues/new)
45
46
  describing your contribution.

47
2. [Fork the Frama-C snapshot repository](https://github.com/Frama-C/Frama-C-snapshot/fork)
48
49
  (choosing your Github account as a destination);

50
3. Clone the forked Frama-C snapshot repository on your computer;
51

52
4. Create and switch in a dedicated branch which should follow the following convention:
53
54
55
56
57
58
  - `bugfix/username/short-description` for bug fixes (correcting an incorrect
  behaviour);
  - `improv/username/short-description` for improvements (making even better a
  functionnally correct behaviour);
  - `feature/username/short-description` for features (adding a new behaviour).

59
5. Locally make your contribution by adding/editing/deleting files and following
60
61
  the [coding conventions](#coding-conventions);

62
6. Optionally locally add non-regression test cases to the appropriate
63
64
65
66
67
68
69
  subdirectory in `./tests/`. The
  [plug-in developer manual](http://frama-c.com/download/frama-c-plugin-development-guide.pdf)
  exemplifies the use of the dedicated `ptests` tool used by Frama-C developers
  in its `hello` tutorial and provides a documentation of it in a full section.
  You can also provide the non-regression test case in the Github issue
  discussion and we will integrate it).

70
7. Check for unexpected changes (in particular spaces and tabulations);
71

72
8. Locally run the test framework of Frama-C by typing
73
74
75
76
77
  ```shell
  make tests
  ```
  in your terminal (you should be in the Frama-C root directory);

78
79
80
81
9. Locally add (if needed) and commit your contribution. The end of the
  commit message should refer to the Github issue to which this commit is
  linked by mentioning its issue identifier preceded by `GH #` (we use the
  `GH` part to track the provenance as we use several issue trackers);
82

83
10. Push your contribution to Github;
84

85
11. [Make a Github pull request](https://github.com/Frama-C/Frama-C-snapshot/compare)
86
87
88
  (toggling the `compare across forks` view). The base fork should remain as
  `Frama-C/Frama-C-snapshot` and the base as `master` while the head fork
  should be yours and the compare should be your chosen branch name.
89

90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
For convenience, we recall the typical `git` commands to be used through these steps:
```shell
git clone https://github.com/<username>/Frama-C-snapshot.git
git checkout -b <branch-name>
git diff --check
git add <file1 file 2>
git commit -m "<Commit message> (GH #<XXX>)"
git push origin <branch-name>
```
where:

- `<username>` is your Github username;
- `<branch-name>` is your chosen branch name;
- `<file1 file2>` are the files to add to the commit;
- `<Commit message>` is your commit message;
- `<XXX>` is the Github issue identifier.

Thibaud Antignac's avatar
minor    
Thibaud Antignac committed
107

Thibaud Antignac's avatar
Thibaud Antignac committed
108
109
Developing external plug-ins
============================
110

111
112
Frama-C is a modular platform for which it is possible to develop external
plug-ins as documented in the
113
[Plug-In development guide](http://frama-c.com/download/frama-c-plugin-development-guide.pdf).
114
115
Such plug-ins normally do not require changes to the Frama-C source code and can
be developed completely independently, for instance in a separate Git
116
repository as exemplified by the [Hello plug-in](https://github.com/Frama-C/frama-c-hello).
117
118
119
120

However, to make it easier for your users to compile and use your plug-in, even
as newer releases are made available, we recommend the following workflow:

121
122
1. Write your external plug-in as indicated in the
  [Plug-In development guide](http://frama-c.com/download/frama-c-plugin-development-guide.pdf);
123

124
125
126
127
128
129
2. Create an `opam` package by
  [pinning your local plug-in](http://opam.ocaml.org/doc/Packaging.html#Opam-pin) and
  [editing the `opam` file](http://opam.ocaml.org/doc/Packaging.html#The-quot-opam-quot-file).
  You can have a look at the
  [`opam` file of the Hello plug-in](https://github.com/Frama-C/frama-c-hello/blob/master/opam)
  if necessary.
130

131
132
133
3. Optionnally
  [publish your plug-in](http://opam.ocaml.org/doc/Packaging.html#Publishing)
  in the official OPAM packages repository.
134

135
136
137
4. Let know the
  [Frama-C-discuss mailing list](https://lists.gforge.inria.fr/mailman/listinfo/frama-c-discuss)
  about your contribution to the Frama-C ecosystem. Well done!
138

139
140
The main advantage of this way to proceed is the delegation to OPAM of the task
of keeping consistent Frama-C versions and dependencies.
Thibaud Antignac's avatar
Thibaud Antignac committed
141

Thibaud Antignac's avatar
minor    
Thibaud Antignac committed
142

Thibaud Antignac's avatar
Thibaud Antignac committed
143
144
145
146
147
148
149
150
151
152
Coding conventions
==================

- Use [ocp-indent](https://github.com/OCamlPro/ocp-indent) to indent files;

- Avoid trailing whitespaces;

- Avoid using tabs;

- Strive to keep within 80 characters per line.