add project-template directory #273

smola · 2018-10-17T10:04:14Z

Project template

Added a directory project-template to use as a template for new projects. 9dc57b1
document directory is still preserved for annex documents that do not belong to projects, as well as some symlinks to avoid breaking a lot of links we have to these files.
Add MAINTAINERS file template.
Put ISSUE_TEMPLATE.md in .github/.
Moved CODE_OF_CONDUCT.md and CONTRIBUTING.md to docs/. db56175

Fixes #93

Licensing

Absorbed #305 here:

use Apache License 2.0 verbatim text. ebc193c
use GPLv3 verbatim text d0f99dc

Plus some small changes:

add NOTICE files, these are the ones where we put copyright holder and year 55f2b7c
use GPL-3.0 or later wording, as recommended by the FSF 840e686
use .md extension for LICENSE and NOTICE, as discussed in this PR. 3fd5f2d

Next steps

Some changes are pending but excluded form this PR to avoid more bloat and easier review:

Better documentation at engineering/documentation.mdadd project-template directory #273 (review)
Pointing code of conduct to the main file on src-d/guide add project-template directory #273 (comment)
Wording improvements add project-template directory #273 (comment) add project-template directory #273 (comment)
Clarify the GPLv3 or later clause in our licensing policy add project-template directory #273 (comment)

mcuadros · 2018-11-07T12:03:55Z

sorry you have a conflict

dpordomingo

thanks for this, I love it!

LGTM

What about of documenting this into engineering/documentation.md? imho it could be also a good idea to document how to locally configurate the init.templatedir as you suggested by #93 (comment)

I have three more questions/suggestions 👇

dpordomingo · 2018-11-26T11:51:23Z

engineering/project-template/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+### _Type_:


Why not storing ISSUE_TEMPLATE.md into .github dir?

👍 for ISSUE_TEMPLATE.md, since it's purely internal to GitHub. I'm not sure about the others.

I agree that the things that are purely GitHub specific could go into .github while the rest could be inside docs (and GitHub will still find them correctly)

dpordomingo · 2018-11-26T11:52:41Z

engineering/project-template/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct


why not pointing each {{repo}}/CODE_OF_CONDUCT.md to https://github.com/src-d/guide/blob/master/.github/CODE_OF_CONDUCT.md as we do with CONTRIBUTING.md, so that way we'll have only one version of that one?

cc @mcuadros @campoy

I think it's a good idea to avoid repetition, yeah

dpordomingo · 2018-11-26T11:53:58Z

engineering/project-template/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contribution Guidelines


We're adding more and more files to the project root which aren't (hardly) related to the application/library itself. I wonder if moving some files to different directories could help to reduce the number of extra files; in this case, I'm wondering about what if we move into .github dir CODE_OF_CONDUCT.md and CONTRIBUTING.md

I was thinking the same. If we don't wanna move it into .github to avoid "vendor lock-in" at least we could move it into the docs directory.

I didn't know that CONTRIBUTING.md could be also stored in docs dir!!!
and it does https://help.github.com/articles/setting-guidelines-for-repository-contributors/

So yes... I'd prefer it too

I will move this to a separate PR.

campoy

Very cool, I'd also add a note regarding whether we should modify the LICENSE file or not (many have asked about this before).

engineering/project-template/CODE_OF_CONDUCT.md

campoy · 2018-11-27T17:53:06Z

engineering/project-template/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contribution Guidelines


I was thinking the same. If we don't wanna move it into .github to avoid "vendor lock-in" at least we could move it into the docs directory.

campoy · 2018-11-27T17:56:30Z

engineering/project-template/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contribution Guidelines
+
+As all source{d} projects, this project follows the


Like all other source{d} projects,

I'll move this to a separate PR.

campoy · 2018-11-27T17:57:11Z

engineering/project-template/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+### _Type_:


I agree that the things that are purely GitHub specific could go into .github while the rest could be inside docs (and GitHub will still find them correctly)

campoy · 2018-11-27T18:02:20Z

engineering/project-template/LICENSE.apache

+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 Sourced Technologies, S.L.


Is 2017 the right number to keep here? Should we keep these updated or write them only once?
For other projects, we've rejected PRs replacing Copyright [yyyy] [name of copyright owner] with this.

BTW, for whatever this is worth on Copyright [year] conventions/legal considerations:

Even in the software licensing roundtable the Linux Foundation organized last year, with all sorts of very high profile people specialized in licensing from OSS world & large corporates, there was no agreement whatsoever on what's the "correct" or "best" practice for this matter, nor if there's any need to update it every year, or provide a range of years…

Year should not be there at all (in that appendix specifically). We discussed about adding NOTICE file for proper copyright notices. This is the Apache Foundation approach, see more here: #305

@marnovo The ASF says the following about NOTICE:

The top of each NOTICE file should include the following text, suitably modified to reflect the product name and year(s) of distribution of the current and past versions of the product:

The FSF says:

To update the list of year numbers, add each year in which you have made nontrivial changes to the package. (Here we assume you’re using a publicly accessible revision control server, so that every revision installed is also immediately and automatically published.) When you add the new year, it is not required to keep track of which files have seen significant changes in the new year and which have not. It is recommended and simpler to add the new year to all files in the package, and be done with it for the rest of the year.

So I assume that the safest choice is including every year in which the project received any non-trivial change.

At least that's ASF and FSF position, which is validated by many years of legal teams crafting copyright policies that can be applied by developers themselves. So sometimes they make rules of thumb that are easily applicable and are overly cautious.

marnovo

Nice one. 👍

marnovo · 2018-11-27T19:01:43Z

engineering/project-template/DCO

@@ -0,0 +1,36 @@
+Developer Certificate of Origin


Is the standard for DCO file not carrying the .md extension? Asking this because in some cases CONTRIBUTING, CODE_OF_CONDUCT, LICENSE have .md extension, others they don't…

We're omitting .md in LICENSE files (what also causes problems in GitBook documentation). GitHub accepts both options, so since it would also fix the problem with links to License in GitBook, I'd choose the .md version

I found no info about DCO but it worths to follow GitHub expectations because doing so it will be shown in PRs (for example)

Let's move the DCO thing to a separate PR.

engineering/project-template/ISSUE_TEMPLATE.md

marnovo · 2018-11-27T19:05:25Z

engineering/project-template/CODE_OF_CONDUCT.md

+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards


marnovo · 2018-11-27T19:34:51Z

engineering/project-template/CODE_OF_CONDUCT.md

+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at conduct@sourced.tech. All


Just make sure conduct@sourced.tech is working + distributes to the right people (i.e. not an additional email someone has to check).

Note that I've just moved the file. I assume this was already done when the CoC was put in place.
cc @campoy @eiso

smola · 2018-11-28T15:15:57Z

@campoy @dpordomingo @marnovo Could you review again? See the updated PR description. I have incorporated some feedback, absorbed #305 here (since it was being discussed together) and listed some changes that we can move to separate PRs.

cc @mcuadros

engineering/project-template/README.md

dpordomingo · 2018-11-28T16:13:53Z

engineering/project-template/NOTICE.md.gpl

@@ -0,0 +1,15 @@
+Copyright (C) 2018 Sourced Technologies, S.L.


From the GPL full text, it is recommended to start with:
<one line to give the program's name and a brief idea of what it does.>

dpordomingo · 2018-12-14T15:51:05Z

Is this ready to be merged?

smola · 2018-12-17T10:44:15Z

@dpordomingo Not without review of at least one person from management since this has implications on licensing.

campoy · 2019-01-11T23:18:52Z

I already approved this, but probably worth having someone else review the licensing concerns.

Maybe @eiso or @jorgeschnura can weigh in?

bzz · 2019-02-25T11:40:33Z

@smola this is very nice! In order to be merged, a conflict with the latest master needs to be resolved, I presume.

dpordomingo · 2019-10-23T06:39:16Z

This PR contains relevant info that is already being used by the facto by many company repos as sourced-ce. I reviewed pending comments, and they were going to be addressed in different PRs, so it would be great if we could merge this and iterate later.
wdyt @smola ?

I also resolved the conflicts force-pushing the repo-tpl branch from 40b7ad1 to 4380083

The final text where we were adding year and copyright holder name is just *an appendix about how to add a notice*, not the notice itself. As found in https://www.apache.org/licenses/LICENSE-2.0.txt Signed-off-by: Santiago M. Mola <santi@mola.io>

As found in https://www.gnu.org/licenses/gpl-3.0.txt Signed-off-by: Santiago M. Mola <santi@mola.io>

Signed-off-by: Santiago M. Mola <santi@mola.io>

Add NOTICE.apache and NOTICE.gpl. One of these should be included for Apache or GPL licenses. Signed-off-by: Santiago M. Mola <santi@mola.io>

This allows proper integration with tools such as Gitbook. Signed-off-by: Santiago M. Mola <santi@mola.io>

Signed-off-by: Santiago M. Mola <santi@mola.io>

Co-Authored-By: smola <santi@mola.io>

smola requested review from campoy and mcuadros October 17, 2018 10:04

smola requested a review from jorgeschnura as a code owner October 17, 2018 10:04

smola changed the title ~~add project-template directory, fixes #93~~ add project-template directory Oct 31, 2018

dpordomingo approved these changes Nov 26, 2018

View reviewed changes

campoy reviewed Nov 27, 2018

View reviewed changes

marnovo approved these changes Nov 27, 2018

View reviewed changes

smola force-pushed the repo-tpl branch 2 times, most recently from 7eb67a6 to 840e686 Compare November 28, 2018 15:05

dpordomingo reviewed Nov 28, 2018

View reviewed changes

engineering/project-template/README.md Outdated Show resolved Hide resolved

engineering/project-template/README.md Show resolved Hide resolved

dpordomingo reviewed Nov 28, 2018

View reviewed changes

engineering/project-template/README.md Show resolved Hide resolved

dpordomingo self-requested a review November 28, 2018 15:54

dpordomingo reviewed Nov 28, 2018

View reviewed changes

campoy approved these changes Dec 4, 2018

View reviewed changes

dpordomingo mentioned this pull request Dec 7, 2018

Enhance docs src-d/lookout-sdk#45

Merged

smola mentioned this pull request Dec 17, 2018

use verbatim license texts #305

Closed

dpordomingo mentioned this pull request Jun 21, 2019

Add NOTICE file src-d/sourced-ui#145

Merged

smola added 6 commits October 23, 2019 08:40

licensing: use GPLv3 verbatim text

d421f0b

As found in https://www.gnu.org/licenses/gpl-3.0.txt Signed-off-by: Santiago M. Mola <santi@mola.io>

add project-template directory, fixes #93

8a1124d

Signed-off-by: Santiago M. Mola <santi@mola.io>

project-template: move CODE_OF_CONDUCT.md and CONTRIBUTING.md to docs

d671ff1

Signed-off-by: Santiago M. Mola <santi@mola.io>

licensing: add NOTICE files

9066f01

Add NOTICE.apache and NOTICE.gpl. One of these should be included for Apache or GPL licenses. Signed-off-by: Santiago M. Mola <santi@mola.io>

project-template: use .md extension for LICENSE and NOTICE

ae30c80

This allows proper integration with tools such as Gitbook. Signed-off-by: Santiago M. Mola <santi@mola.io>

smola and others added 2 commits October 23, 2019 08:47

licensing: use GPL-3.0 or later

44003d9

Signed-off-by: Santiago M. Mola <santi@mola.io>

Update engineering/project-template/README.md

4380083

Co-Authored-By: smola <santi@mola.io>

dpordomingo force-pushed the repo-tpl branch from 40b7ad1 to 4380083 Compare October 23, 2019 06:49

dpordomingo merged commit 2ec75fd into master Nov 29, 2019

dpordomingo deleted the repo-tpl branch November 29, 2019 09:18

		@@ -0,0 +1,13 @@
		# Contribution Guidelines

		As all source{d} projects, this project follows the

		@@ -0,0 +1,15 @@
		Copyright (C) 2018 Sourced Technologies, S.L.

add project-template directory #273

add project-template directory #273

Uh oh!

Conversation

smola commented Oct 17, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Project template

Licensing

Next steps

Uh oh!

mcuadros commented Nov 7, 2018

Uh oh!

dpordomingo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

campoy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

smola Nov 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marnovo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

smola commented Nov 28, 2018

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dpordomingo commented Dec 14, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

smola commented Oct 17, 2018 •

edited

Loading

smola Nov 28, 2018 •

edited

Loading

dpordomingo commented Dec 14, 2018 •

edited

Loading

dpordomingo commented Oct 23, 2019 •

edited

Loading