Skip to content

Commit

Permalink
Merge pull request #2362 from dedis/contributing
Browse files Browse the repository at this point in the history
Documentation
  • Loading branch information
Jeff R. Allen committed Aug 19, 2020
2 parents 9fec3c0 + d14a454 commit 48d81a8
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 30 deletions.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,3 +133,43 @@ Every debug-function has also a -*f*-function: `Lvl1` and `Lvlf1`, `Lvl2` and
`Lvlf2`..., `Print` and `Printf`, `Fatal` and `Fatalf`, `Error` and `Errorf`.

The format-functions work like `fmt.Printf`.

## Pre-commit

As of August 2020, we use the [pre-commit](https://pre-commit.com/) framework
to make sure the code is up-to-date with regard to formatting and linting.
After installation, you can launch this locally with

```bash
pre-commit
```

This will make sure that all changed files pass our linting- and formatting
preferences.

# Licenses

Cothority is an Open Source program with many contributors (listed in the AUTHORS
files), so we actively seek contributions (help on the Cothority users list,
documentation, source code, ideas, …). All contributions help us make a
better product.

All contributions without an explicit copyright statement or a CLAI/CLAC (see below)
are assumed to be covered under a AGPL 2-Clause license as described in the
file LICENSE.

Developers who have contributed significant changes to the Cothority code must sign
a Contributor License Agreement (CLAI), eventually also a CLAC if they work for
a corporation. Together they guarantee them the right to use the code they have
developed, and also ensures that EPFL/DEDIS (and thus the Cothority project) has the
rights to the code.
By signing the CLAI/CLAC, your contributions are eligible to be integrated into the
Cothority source code.
Having the CLAI/CLAC signed is essential for the Cothority project to maintain a
clean copyright and guarantees that Cothority and your source code will always remain
Free Software (Open Source).
Providing that your contribution is accepted by the Cothority project, your signed
CLAI/CLAC also permits EPFL/DEDIS to submit your contribution for use in other
EPFL/DEDIS-projects.

The Contributor License Agreements are in the [CLAI] and [CLAC]-file.
26 changes: 0 additions & 26 deletions CONTRIBUTION

This file was deleted.

6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,10 +276,8 @@ explains how to join the DEDIS-cothority
## Contributing

If you want to contribute to Cothority-ONet, please have a look at
[CONTRIBUTION](CONTRIBUTION.md) for
licensing details. Once you are OK with those, you can have a look at our
coding-guidelines in
[Coding](https://github.com/dedis/Coding). In short, we use the github-issues
[CONTRIBUTING](CONTRIBUTING.md) for our coding practice and
licensing details. In short, we use the github-issues
to communicate and pull-requests to do code-review. Travis makes sure that
everything goes smoothly. And we'd like to have good code-coverage.

Expand Down

0 comments on commit 48d81a8

Please sign in to comment.