Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributor agreement and copyright update. #2730

Merged
merged 7 commits into from
Jul 18, 2018
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
21 changes: 21 additions & 0 deletions ACKNOWLEDGEMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Acknowledgement for non-Cylc Work

Licences for non-cylc work included in this distribution can be found in the
`licences/` directory.
* `lib/cherrypy/`:
External software library released under a BSD license.
Minor modification to ignore an import warning.
See [cherrypy](http://www.cherrypy.org/).
* `lib/isodatetime/`:
Unmodified external software library released under the LGPL license.
See [metomi/isodatetime](https://github.com/metomi/isodatetime/).
* `lib/jinja2/`:
External software library released under a BSD license.
See [Jinja2](http://jinja.pocoo.org/).
* `lib/markupsafe/`:
External software library released under a BSD license, used by Jinja2.
See [MarkupSafe](http://www.pocoo.org/projects/markupsafe/).
* `lib/xdot.py`:
External software released under the LGPL license.
Modifications based on version 0.6. See
[xdot](https://github.com/jrfonseca/xdot.py)
106 changes: 106 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# Cylc: How to Contribute

## Report Bugs

Report bugs by opening an issue at [Cylc Issues on
Github](https://github.com/cylc/cylc/issues). Give the Cylc version affected
by the bug (you should test the latest release if possible) and a recipe to
reproduce the problem.

## Request Enhancements

Request enhancements by opening an issue at [Cylc Issues @
Github](https://github.com/cylc/cylc/issues). Describe your use case in detail.

## Contribute Code

All contributions to Cylc are made via pull requests against the *master*
branch of [cylc/cylc](https://github.com/cylc/cylc). New contributors
should add their details to the [Code Contributors](#code-contributors)
section of this file as part of their first pull request. The developers who
review each pull request are responsible for checking that the contributor's
name is listed in this file before merging the new branch into *master*.

## Code Contributors

The following people have contributed to this code under the terms of
the Contributor Licence Agreement and Certificate of Origin detailed
below (_except for the parenthesised names, which represent contributions
from outside of NIWA and Met Office that predate the explicit introduction of
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be "the Met Office"

this Agreement in July 2018; they must be un-parenthesised in future pull
requests_).

- Hilary Oliver
- Matt Shin
- Ben Fitzpatrick
- Andrew Clark
- Oliver Sanders
- Declan Valters
- Sadie Bartholomew
- (Luis Kornblueh)
- Kerry Day
- Prasanna Challuri
- David Matthews
- (Tim Whitcomb)
- (Scott Wales)
- Tomek Trzeciak
- (Thomas Coleman)
- Bruno Kinoshita
- (Annette Osprey)
- (Jonathan Thomas)
- Rosalyn Hatcher
- (Domingo Manubens Gil)
- Jonny Williams
- (Milton Woods)
- (Alex Reinecke)
- (Chan Wilson)
- (Kevin Pulo)
- Lois Hugget
- (Martin Dix)
- (Ivor Blockley)

(All contributors are identifiable with email addresses in the git version
control logs or otherwise.)

## Contributor Licence Agreement and Certificate of Origin

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I have
the right to submit it, either on my behalf or on behalf of my
employer, under the terms and conditions as described by this file;
or

(b) The contribution is based upon previous work that, to the best of
my knowledge, is covered under an appropriate licence and I have
the right or permission from the copyright owner under that licence
to submit that work with modifications, whether created in whole or
in part by me, under the terms and conditions as described by
this file; or

(c) The contribution was provided directly to me by some other person
who certified (a) or (b) and I have not modified it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including my
name and email address) is retained for the full term of
the copyright and may be redistributed consistent with this project
or the licence(s) involved.

(e) I, or my employer, grant to NIWA and all recipients of
this software a perpetual, worldwide, non-exclusive, no-charge,
royalty-free, irrevocable copyright licence to reproduce, modify,
prepare derivative works of, publicly display, publicly perform,
sub-licence, and distribute this contribution and such modifications
and derivative works consistent with this project or the licence(s)
involved or other appropriate open source licence(s) specified by
the project and approved by the
[Open Source Initiative (OSI)](http://www.opensource.org/).

(f) If I become aware of anything that would make any of the above
inaccurate, in any way, I will let NIWA know as soon as
I become aware.

(The Cylc Contributor Licence Agreement and Certificate of Origin is
inspired that of [Rose](https://github.com/metomi/rose), which in turn was
inspired by the Certificate of Origin used by Enyo and the Linux Kernel.)
13 changes: 3 additions & 10 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Cylc Installation.
# Cylc: Quick Installation Guide

**See also [The Cylc User Guide](https://cylc.github.io/cylc/documentation.html).**
**See [The Cylc User Guide](https://cylc.github.io/cylc/documentation.html) for
more detailed information.**

Cylc must be installed on suite and task job hosts. Third-party dependencies
(below) are not required on job hosts.
Expand Down Expand Up @@ -101,11 +102,3 @@ Summary:

After running `make`, copy the `doc/install` directory to a location such as
`/var/www/html/` and update your Cylc site config file to point to it.

### Cloning The Cylc Repository

To participate in Cylc development fork [Cylc on
GitHub](https://github.com/cylc/cylc) and make a local clone of your own fork
to work in. Changes should be developed in feature branches then pushed to
your GitHub fork before issuing a Pull Request to the team. Please post an
Issue to discuss proposed changes before you begin any signficant work.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
69 changes: 14 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# The Cylc Workflow Engine

[![Build Status](https://travis-ci.org/cylc/cylc.svg?branch=master)](https://travis-ci.org/cylc/cylc)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/1d6a97bf05114066ae30b63dcb0cdcf9)](https://www.codacy.com/app/Cylc/cylc?utm_source=github.com&utm_medium=referral&utm_content=cylc/cylc&utm_campaign=Badge_Grade)
[![DOI](https://zenodo.org/badge/1836229.svg)](https://zenodo.org/badge/latestdoi/1836229)

Cylc (“silk”) orchestrates complex distributed suites of interdependent cycling
tasks. It was originally designed for environmental forecasting systems at
[NIWA](https://www.niwa.co.nz).
(or non-cycling) tasks. It was originally designed to automate environmental
forecasting systems at [NIWA](https://www.niwa.co.nz). Cylc is a general
workflow engine, however; it is not specialized to forecasting in any way.

[Quick Installation](INSTALL.md) |
[Web Site](https://cylc.github.io/cylc) |
[Documentation](https://cylc.github.io/cylc/documentation) |
[Contributing](CONTRIBUTING.md)

### Copyright and Terms of Use

Copyright (C) 2008-2018 NIWA
Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors

Cylc is free software: you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software Foundation,
Expand All @@ -20,59 +27,11 @@ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
cylc. If not, see [GNU licenses](http://www.gnu.org/licenses/).
Cylc. If not, see [GNU licenses](http://www.gnu.org/licenses/).

## Cylc Documentation
* See [The Cylc Web Site](https://cylc.github.io/cylc)

## Code Contributors
<!-- git shortlog -s -n -->
* Hilary Oliver
* Matt Shin
* Ben Fitzpatrick
* Andrew Clark
* Oliver Sanders
* Declan Valters
* Sadie Bartholomew
* Luis Kornblueh
* Kerry Day
* Prasanna Challuri
* David Matthews
* Tim Whitcomb
* Scott Wales
* Tomek Trzeciak
* Thomas Coleman
* Bruno Kinoshita
* Annette Osprey
* Jonathan Thomas
* Rosalyn Hatcher
* Domingo Manubens Gil
* Jonny Williams
* Milton Woods
* Alex Reinecke
* Chan Wilson
* Kevin Pulo
* Lois Hugget
* Martin Dix
* Ivor Blockley

## Acknowledgement For Non-Cylc Work:
Licences for non-cylc work included in this distribution can be found in the
`licences/` directory.
* `lib/cherrypy/`:
External software library released under a BSD license.
Minor modification to ignore an import warning.
See [cherrypy](http://www.cherrypy.org/).
* `lib/isodatetime/`:
Unmodified external software library released under the LGPL license.
See [metomi/isodatetime](https://github.com/metomi/isodatetime/).
* `lib/jinja2/`:
External software library released under a BSD license.
See [Jinja2](http://jinja.pocoo.org/).
* `lib/markupsafe/`:
External software library released under a BSD license, used by Jinja2.
See [MarkupSafe](http://www.pocoo.org/projects/markupsafe/).
* `lib/xdot.py`:
External software released under the LGPL license.
Modifications based on version 0.6. See
[xdot](https://github.com/jrfonseca/xdot.py)
## Acknowledgement for non-Cylc Work

See [Acknowledgement for Non-Cylc Work](ACKNOWLEDGEMENT.md).
2 changes: 1 addition & 1 deletion bin/cycl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
#
# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-5to6
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-bcast
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash
#
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-broadcast
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python2

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-browse
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash
#
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-cat-log
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python2

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-cat-state
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python2

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-check-software
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python2

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-check-triggering
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python2

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-check-versions
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python2

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-checkpoint
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python2

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-client
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python2

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-compare
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash
#
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-conditions
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-cycle-point
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion bin/cylc-cyclepoint
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash
#
# Copyright (C) 2008-2018 NIWA
# Copyright (C) 2008-2018 NIWA & British Crown (Met Office) & contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
Loading