Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 2.16 KB

PROJECT.md

File metadata and controls

63 lines (47 loc) · 2.16 KB

Project Guidelines

Each project repository requires, at a minimum:

  1. Readme -- README.md
  2. License -- LICENSE
  3. Contributing Guidelines -- .github/CONTRIBUTING.md
  4. Issue Template -- .github/ISSUE_TEMPLATE.md

Readme

Each readme follows a README.md template

License

GPLv3--or AGPLv3 (why Affero? )--is our preferred license for code, and Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) for creative works and documentation.

We also use a License and Copyright block, added to our READMEs, add a LICENSE to the repo, and occasionally include a Code Header License block.

License & Copyright README block

## License & Copyright

Copyright (C) <year> Data Together
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 the Free Software
Foundation, version 3.0.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.

See the [`LICENSE`](./LICENSE) file for details.

Code Header License block

/**
 * Copyright (C) <year(s)> Data Together
 * 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 the Free
 * Software Foundation, version 3.0.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See LICENSE file for details.
 */

Contributing Guidelines

We use a CONTRIBUTING.md template that points to our main Contributing Guidelines located in datatogether/datatogether, the template can be extended to cover project- or repo- specific requirements.