Skip to content

Commit 284d7ff

Browse files
committed
Add a contributing file
1 parent aff6cee commit 284d7ff

File tree

3 files changed

+42
-2
lines changed

3 files changed

+42
-2
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ install-sh
1515
.openmodelica.aspell
1616
OMPython/
1717
OpenModelicaSetup/
18-
NewDocumentation/
18+
NewDocumentation/
19+
.settings

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# How to contribute to the OpenModelica Compiler
2+
3+
Note that your contributions are assumed to follow the [contributor license agreement](https://openmodelica.org/osmc-pl/osmc-pl-1.2.txt) (which means the [Open Source Modelica Consortium](https://openmodelica.org) holds the copyright).
4+
5+
Contributions are primarily in the form of pull requests.
6+
To learn more about [collaboration, see the github articles](https://help.github.com/categories/collaborating/).
7+
Fork the OpenModelica repositories into your user account, create a
8+
topic branch (not master) which you make your changes in and push to
9+
your own fork. The reason for the topic branch is to isolate your changes.
10+
If you want to fix two different things, create two different branches
11+
to make the changes easier to review.
12+
13+
Note that [@OpenModelica-Hudson](https://github.com/OpenModelica-Hudson/)
14+
will rebase your changes on top of master, which means that if you create
15+
new commits on top of your topic branch, your changes might be hard to
16+
merge with the master.
17+
18+
Commits that are pushed to this repository should pass the [test suite](https://github.com/OpenModelica/OpenModelica-testsuite),
19+
and [@OpenModelica-Hudson](https://github.com/OpenModelica-Hudson/) makes sure this is true.
20+
21+
Developers can trigger the Hudson job [OpenModelica hudson job](https://test.openmodelica.org/hudson/job/OpenModelica_TEST_PULL_REQUEST/build?delay=0sec)
22+
after creating a pull request to trigger a build+test+push from a pull
23+
request (or directly from the developer's own branch). The Hudson job
24+
refuses to build any hash other than the latest hash in the pull request,
25+
which automatically syncs to the fork. It is thus important that if the
26+
pull request is finished, no more commits are pushed unless they fix
27+
something.
28+
29+
All commits should adhere to the following simple guidelines (the Hudson
30+
job checks some of these restrictions, and will automatically reject your
31+
submission if the reviewer missed it):
32+
33+
* Use UTF-8 as file encoding.
34+
* No trailing whitespace in text-files.
35+
* No binary files added (object files, etc). Images are fine for icons in the graphical clients. Note that images should use vector graphics (SVG) as far as it is possible to do so.
36+
* No automatically generated code added. This includes documentation such as Doxygen.
37+
* No adding+deleting the same file or line (debug lines/etc). Do an interactive rebase to squash the commits into one.
38+
* If you have many added+deleted files/etc - squash all commits into a single commit instead.
39+
* For OpenModelica-testsuite: Any added or modified reference file needs to use [filterSimulationResults](https://openmodelica.org/doc/OpenModelicaUsersGuide/latest/scripting_api.html#filtersimulationresults) to create a file with a minimal number of trajectories and output points in order to reduce the file size.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ In order to push to the repository, you will push to your own fork of OMCompiler
5151

5252
### How to contribute to the OpenModelica Compiler
5353

54-
See [OMCompiler.git](https://github.com/OpenModelica/OMCompiler/blob/master/README.md#how-to-contribute-to-the-openmodelica-compiler).
54+
See [CONTRIBUTING.md](https://github.com/OpenModelica/OpenModelica/blob/master/CONTRIBUTING.md).
5555

5656
### To checkout a minimal version of OpenModelica
5757
```bash

0 commit comments

Comments
 (0)