Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove effectivly empty CONTRIBUTING files #2448

Open
2 tasks done
HannesWell opened this issue Oct 11, 2024 · 1 comment
Open
2 tasks done

Remove effectivly empty CONTRIBUTING files #2448

HannesWell opened this issue Oct 11, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@HannesWell
Copy link
Member

Let's make sure issue is not already fixed in latest builds first.

Suggestion

Currently many repositories for Eclipse-Platform, Equinox, JDT and PDE have have CONTRIBUTING or a CONTRIBUTING.md file or both that most of the time just contains a link to the contribution information maintained in the corresponding organization's .github repository.

For example in the eclipse.platform repository

That link is then also often repeated in a Contributing section in the README.md of the repository.
See for example

With that the content of the CONTRIBUTING seems to be duplicated and actually not necessary.
Therefore I propose to delete the CONTRIBUTING if the scenario is as described above.

If I read the Eclipse Foundation Project Handbook correct, having a CONTRIBUTING is not mandatory per project and contributing information can also be contained in the README:

@waynebeaton is that correct or are we not allowed to perform the proposed task?

The contribution information generated by GitHub for a repository inherits the CONTRIBUTING file/information from the organization if no such file exists in the repository. For the jdt.debug repository this proposal was already applied and it worked as expected there:

See https://github.com/eclipse-jdt/eclipse.jdt.debug/contribute

On the other hand https://github.com/eclipse-jdt/eclipse.jdt.debug/contribute currently needs one more click to reach the final destination.

Community

  • I understand suggesting an enhancement doesn't mandate anyone to implement it. Other contributors may consider this suggestion, or not, at their own convenience. The most efficient way to get it fixed is that I implement it myself and contribute it back as a good quality patch to the project.
@HannesWell
Copy link
Member Author

@waynebeaton would this change be fine from a legal l respectively project rules point of view?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant