search

eclipse-platform / .github

Common contribution content for eclipse-platform repositories
https://www.eclipse.org/eclipse/
5 stars 10 forks source link

Clean up contributing information #119

Closed sratz closed 1 year ago

sratz commented 1 year ago

The contributing information for eclipse-platform is currently all over the place.

Proposal:

BeckerWdf commented 1 year ago

See also #120

vogella commented 1 year ago

+1

Just send PR for the changes, leading my change is a good way to get this going.

BeckerWdf commented 1 year ago

CONTRIBUTING.md points at the very end to https://wiki.eclipse.org/Platform/How_to_Contribute which in turns says that it's outdated and point back to CONTRIBUTING.md.

This is not really helpful.

HeikoKlare commented 1 year ago

Indeed. I would propose to extract important information from the wiki page to the CONTRIBUTING.md (if any remains), remove the link to the wiki page and move the information there to some dedicated archive page to which no one can navigate by accident using remaining links pointing to the wiki page.

jonahgraham commented 1 year ago

I recommend you delete all content off the old wiki page, but don't actually move it and instead add a banner like I did for CDT:

Note: The contents of this page has been migrated to GitHub. Please see the CDT on GitHub for current information, or the page history for historical versions.

This is what I eventually decided to do after trying a bunch of other ways to indicate the migration.

BeckerWdf commented 1 year ago

The file also says:

All contributors, who are not committers on this Eclipse project, must electronically sign the Eclipse Contributor Agreement (ECA) via their Eclipse account.

For me this would imply that committers of the project don't need to sign the ECA which I think is wrong. I think everybody needs to sign the ECA. So wouldn't it be better to write :

All contributors must electronically sign the Eclipse Contributor Agreement (ECA) via their Eclipse account.

akurtakov commented 1 year ago

Is there anything still to do here? A number of repositories have been merged and docs updated so I would rather close this one and see more dedicated ones opened.

sratz commented 1 year ago

Is there anything still to do here? A number of repositories have been merged and docs updated so I would rather close this one and see more dedicated ones opened.

Agreed. I think we have reached a state where everything is consolidated in a single place an we can now improve incrementally if needed.

HeikoKlare commented 1 year ago

I also think that the documentation is much better now.

Still I like the proposal by @jonahgraham to completely remove the contributing information in the old wiki instead of only having a small marker that the information could be outdated at the top of the page. The information would still be archived in the page history. Any objection to removing that wiki page?

I recommend you delete all content off the old wiki page, but don't actually move it and instead add a banner like I did for CDT:

Note: The contents of this page has been migrated to GitHub. Please see the CDT on GitHub for current information, or the page history for historical versions.

This is what I eventually decided to do after trying a bunch of other ways to indicate the migration.

BeckerWdf commented 1 year ago

I also think that the documentation is much better now.

Still I like the proposal by @jonahgraham to completely remove the contributing information in the old wiki instead of only having a small marker that the information could be outdated at the top of the page. The information would still be archived in the page history. Any objection to removing that wiki page?

No objections from my side.

sratz commented 1 year ago

Still I like the proposal by @jonahgraham to completely remove the contributing information in the old wiki instead of only having a small marker that the information could be outdated at the top of the page. The information would still be archived in the page history. Any objection to removing that wiki page?

+1 (missed that one)