search

eclipse-platform / .github

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

Consolidate README.md files #121

Closed HeikoKlare closed 1 year ago

HeikoKlare commented 1 year ago

There are currently two README.md files: one for this repository and one in the profile folder to be presented at the organization's landing page.

The two files seem to be pretty redundant and have evolved independently. I propose to remove the redundancy by merging them into the one in the profile directory, as that is the one presented at the eclipse-platform organization. I have incorporated the changes made to the README.md of this repository into the one of the organization, which are in particular the changes proposed by @kthoms in #95. The contents of the local README.md contents are replaced with a link to the organization's README.md.

As a minor addition, I have added a hint to check existing issues when reporting a new one together with a link to the aggregated issues page of the organization.

Of course, let me know if I missed something and there is a reason for having separate README.md files.

Contributes to #119.

HeikoKlare commented 1 year ago

Since these changes affect the central eclipse-platform organization's landing page, I propose to keep the PR open for at least one day to give the chance for feedback, even though it is already approved.