Skip to content

[ZEPPELIN-1414] Remove CONTRIBUTING.md files#1406

Closed
corneadoug wants to merge 4 commits intoapache:masterfrom
corneadoug:ZEPPELIN-1414
Closed

[ZEPPELIN-1414] Remove CONTRIBUTING.md files#1406
corneadoug wants to merge 4 commits intoapache:masterfrom
corneadoug:ZEPPELIN-1414

Conversation

@corneadoug
Copy link
Contributor

What is this PR for?

Following the PR #1356, we now have the contribution documentation to on Apache Zeppelin Website.

We can now remove the contributing files from the repository, and replace the links to that documentation.

What type of PR is it?

Documentation

What is the Jira issue?

https://issues.apache.org/jira/browse/ZEPPELIN-1414

How should this be tested?

Just check if there is other CONTRIBUTING.md files and if there is other links to replace

Questions:

  • Does the licenses files need update? No
  • Is there breaking changes for older versions? No
  • Does this needs documentation? No

@AhyoungRyu
Copy link
Contributor

@corneadoug There is one more "how to contribute" link - http://zeppelin.apache.org/docs/0.7.0-SNAPSHOT/#100-opensource :)

@corneadoug
Copy link
Contributor Author

@AhyoungRyu Yes, this one could also be replaced.
There is actually a few pages of content inside the docs directory that we may want to move to the website later, so maybe we should create a JIRA issue for that migration too.

@jongyoul
Copy link
Member

jongyoul commented Sep 6, 2016

Good! I like it!

@felixcheung
Copy link
Member

felixcheung commented Sep 7, 2016

Not sure if it's important, having a file called Contributing.md, github actually automatically notifies the person creating a PR like this:
image
https://help.github.com/articles/setting-guidelines-for-repository-contributors/

@AhyoungRyu
Copy link
Contributor

@felixcheung Yeah right. It makes sense. Then how about putting root CONTRIBUTING.md back and providing this link https://zeppelin.apache.org/contribution/contributions.html with proper message in that page? We can just let users know that our contribution guide is in Zeppelin website :)

@corneadoug
Copy link
Contributor Author

@felixcheung Right, this message is showing if you have a CONTRIBUTING.md file in the root of the repository.
But we are also using the PR_TEMPLATE that github supports, and we have pretty much the same sentence inside of it: First time? Check out the contributing guide - https://zeppelin.apache.org/contribution/contributions.html

@felixcheung
Copy link
Member

right, I'm not sure if that makes a difference to us

@corneadoug
Copy link
Contributor Author

As long as it's still shown somewhere during the PR process, I think its fine?
Should we merge this then?

@AhyoungRyu
Copy link
Contributor

LGTM 👍

@asfgit asfgit closed this in 56bbff3 Sep 8, 2016
@corneadoug corneadoug deleted the ZEPPELIN-1414 branch September 9, 2016 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants