Skip to content
This repository has been archived by the owner on Nov 5, 2019. It is now read-only.

Latest commit

 

History

History
104 lines (79 loc) · 3.95 KB

PROJECT.md

File metadata and controls

104 lines (79 loc) · 3.95 KB

Project Guidelines

Here are our guidelines that all project repositories for Data Together should follow, if setting up new repositories we have templates. In addition, command line tools like hub and ghi can help with multi-repository label and issue management

Repository Contents

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 file follows a README.md template and serves to introduce people to the repository contents and provide getting started instructions, as well as link to Data Together-wide communication channels.

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. We also add a LICENSE file to the repo, and occasionally include a Code Header License block.

License & Copyright block for READMEs

## 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.

Issue Template

Our ISSUE_TEMPLATE.md template is intended to help triage issues opened for service and package repositories. Additional documentation, frequently asked questions, and supports can be added.

Style Guidelines

We have a minimal set of style guidelines we follow to prevent confusion and maintain a consistend pattern to aid outreach and onboarding newcomers!

  • Our project name is "Data Together" with a space between the words
  • Golang repository names, folders, and code should be lowercase snakecase (like_this)
  • Readme, license, and "github files" should be UPPERCASE (e.g., CONDUCT.md, README.md, CONTRIBUTING.md, ISSUE_TEMPLATE.md, LICENSE)
  • We hide GitHub stuff (CONTRIBUTING.md, ISSUE_TEMPLATE.md) in a .github folder within every repository
  • Aside from code, en-dashes "-" are fine for many things including GitHub labels, tags, and more!