Skip to content

Commit

Permalink
Add a CONTRIBUTING file
Browse files Browse the repository at this point in the history
  • Loading branch information
sjoelund committed Jun 22, 2015
1 parent 164e53e commit ef62d68
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 9 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,3 @@
# How to contribute to the OpenModelica Compiler

See [OpenModelica.git](https://github.com/OpenModelica/OpenModelica/blob/master/CONTRIBUTING.md).
9 changes: 0 additions & 9 deletions README.md
@@ -1,15 +1,6 @@
# OMCompiler
The OpenModelica Compiler is the core of the OpenModelica project, which is an open-source Modelica-based modeling and simulation environment intended for industrial and academic usage.

## How to contribute to the OpenModelica Compiler

Contributions are primarily in the form of [pull requests](https://github.com/OpenModelica/OMCompiler/pulls).
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).

Commits that are pushed to this repository should pass the [test suite](https://github.com/OpenModelica/OpenModelica-testsuite), and @OpenModelica-Hudson makes sure this is true.
Developers should push their changes elsewhere and use the [OpenModelica hudson job](https://test.openmodelica.org/hudson/job/OpenModelica_TEST_PULL_REQUEST/build?delay=0sec) to trigger a build+push (it can build from a given URL+branch or a specific pull request, as desired).
It is recommended to use a feature branch for pull requests since hudson may rebase them, which in turn would make it harder to merge the changes.

## Building the OpenModelica Compiler

There are [Linux instructions](README.Linux.md) available.

0 comments on commit ef62d68

Please sign in to comment.