search

github / markup

Determines which markup library to use to render a content file (e.g. README) on GitHub
MIT License
5.84k stars 3.4k forks source link

Enhancement: Display CONTRIBUTING and OPEN_SOURCE Files at the Bottom of GitHub Page #1803

Closed MrArnaudMichel closed 2 months ago

MrArnaudMichel commented 4 months ago

Enhancement: Display CONTRIBUTING and OPEN_SOURCE Files at the Bottom of GitHub Page

Description

Currently, in the default view of a GitHub repository, the CONTRIBUTING and OPEN_SOURCE files (if they exist) are not always prominently featured for potential contributors. However, these files play a crucial role in engaging the community and facilitating contribution to the project.

Therefore, I propose that these files be added at the bottom of the GitHub page, alongside the README and LICENSE files, to make them more accessible and visible to all visitors of the repository.

Benefits for the Community

  1. Facilitates Contribution: By placing the CONTRIBUTING and OPEN_SOURCE files at the bottom of the page, we make them more visible, encouraging potential contributors to review these guidelines before submitting contributions.

  2. Increased Transparency: Highlighting these files demonstrates our commitment to an open and collaborative community. It enhances transparency around contribution processes and expectations for contributors.

  3. Improves User Experience: For newcomers, quickly finding information on how to contribute is crucial. By placing them near the bottom of the page, we streamline navigation and provide a better user experience.

Proposed Implementation

  1. Modify the GitHub page structure to include the CONTRIBUTING and OPEN_SOURCE files alongside the README and LICENSE files.

  2. Update contribution guidelines and open-source information to reflect this change.

github-actions[bot] commented 2 months ago

Stale issue message

RokeJulianLockhart commented 2 months ago

https://github.com/github/markup/issues/1803#issuecomment-2212427642

@GitHub-Actions, what does that mean?