Skip to content

Commit

Permalink
refs modelica#2788: Document CLA assistant (modelica#3306)
Browse files Browse the repository at this point in the history
  • Loading branch information
beutlich authored Jan 13, 2020
1 parent 6f39a8d commit 8db3083
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 14 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@ The [workflow for outside collaborators](https://guides.github.com/activities/fo
5. Once you are done, push your branch to your fork.
6. Go to the upstream ModelicaStandardLibrary repository and submit a
[Pull Request](https://help.github.com/articles/about-pull-requests/) (PR).
If the PR is related to a certain issue, reference it by its number like this: #2161.
Once a pull request is opened, you can discuss and
* If the PR is related to a certain issue, reference it by its number like this: #2161.
* Once a pull request is opened, you can discuss and
[review](https://help.github.com/articles/about-pull-request-reviews/)
the potential changes with collaborators and add follow-up commits before
the changes are merged into the repository.
* If you have not already signed the Modelica Association Contributor License Agreement (CLA) you need to do so one-time.
You can sign the CLA electronically using the CLA Assistant service and your GitHub account. There is no need to scan and send any documents by mail.
7. Update your branch with the requested changes. If necessary, merge the latest
master into your branch and solve all merge conflicts in your branch.
21 changes: 10 additions & 11 deletions Modelica/package.mo
Original file line number Diff line number Diff line change
Expand Up @@ -2263,19 +2263,18 @@ The general <a href=\"https://guides.github.com/activities/forking/\">contributi
<li>Fork the repository to your account by
<a href=\"https://help.github.com/articles/fork-a-repo/\">using the Fork button</a> of the GitHub repository site.</li>
<li>Clone the forked repository to your computer. Make sure to checkout the maintenance branch if the bug fix is going to get merged to the maintenance branch.</li>
<li>Create a new topic branch and give it a meaningful name,
like, e.g., \"issue2161-fix-formula\".</li>
<li>Do your code changes and commit them, one change per commit.
Single commits can be copied to other branches.
<li>Create a new topic branch and give it a meaningful name, like, e.g., \"issue2161-fix-formula\".</li>
<li>Do your code changes and commit them, one change per commit.<br>
Single commits can be copied to other branches.<br>
Multiple commits can be squashed into one, but splitting is difficult.</li>
<li>Once you are done, push your topic branch to your forked repository.</li>
<li>Go to the upstream <a href=\"https://github.com/modelica/ModelicaStandardLibrary.git\">https://github.com/modelica/ModelicaStandardLibrary.git</a> repository and submit a
<a href=\"https://help.github.com/articles/about-pull-requests/\">Pull Request</a> (PR).
If the PR is related to a certain issue, reference it by its number like this: #2161.
Once a pull request is opened, you can discuss and
<a href=\"https://help.github.com/articles/about-pull-request-reviews/\">review</a>
the potential changes with collaborators and add follow-up commits before
the changes are merged into the repository.</li>
<li>Go to the upstream <a href=\"https://github.com/modelica/ModelicaStandardLibrary.git\">https://github.com/modelica/ModelicaStandardLibrary.git</a> repository and submit a <a href=\"https://help.github.com/articles/about-pull-requests/\">Pull Request</a> (PR).
<ul>
<li>If the PR is related to a certain issue, reference it by its number like this: #2161.</li>
<li>Once a pull request is opened, you can discuss and <a href=\"https://help.github.com/articles/about-pull-request-reviews/\">review</a> the potential changes with collaborators and add follow-up commits before the changes are merged into the repository.</li>
<li>If you have not already signed the Modelica Association Contributor License Agreement (CLA) you need to do so one-time.<br>
You can sign the CLA electronically using the CLA Assistant service and your GitHub account. There is no need to scan and send any documents by mail.</li>
</ul></li>
<li>Update your branch with the requested changes. If necessary, merge the latest
\"master\" branch into your topic branch and solve all merge conflicts in your topic branch.</li>
</ol>
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Note, the usage of a Modelica library requires a Modelica simulation environment

![ModelicaLibraries](Modelica/Resources/Images/UsersGuide/ModelicaLibraries.png)


## Current release

[Modelica Standard Library v3.2.3+build.3 (2019-09-21)](https://github.com/modelica/ModelicaStandardLibrary/releases/tag/v3.2.3+build.3)
Expand All @@ -24,7 +23,12 @@ Browse the [Releases](https://github.com/modelica/ModelicaStandardLibrary/releas
This Modelica package is free software and the use is completely at your own risk;
it can be redistributed and/or modified under the terms of the [3-Clause BSD License](LICENSE).

## Status

[![CI checks](https://travis-ci.org/modelica/ModelicaStandardLibrary.svg?branch=master)](https://travis-ci.org/modelica/ModelicaStandardLibrary) [![CLA assistant](https://cla-assistant.io/readme/badge/modelica/ModelicaStandardLibrary)](https://cla-assistant.io/modelica/ModelicaStandardLibrary)

## Development and contribution

The development is organised by the [Modelica Association Project - Libraries (MAP-LIB)](https://www.modelica.org/projects).
See also the [contribution guide](CONTRIBUTING.md) and the [MAP-LIB Project Rules](https://github.com/modelica/MAP-LIB_ProjectRules) for more information.

Expand Down

0 comments on commit 8db3083

Please sign in to comment.