Skip to content

Suggest to create README and LICENSE file when not exist #15626

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

Open
davidak opened this issue Apr 26, 2021 · 4 comments
Open

Suggest to create README and LICENSE file when not exist #15626

davidak opened this issue Apr 26, 2021 · 4 comments
Labels
type/proposal The new feature has not been accepted yet but needs to be discussed first.

Comments

@davidak
Copy link

davidak commented Apr 26, 2021

We at @Codeberg-org would like to suggest to our users to create README and LICENSE files, so the repos are more useful for the community.

https://codeberg.org/Codeberg/Community/issues/293
https://codeberg.org/Codeberg/Community/issues/414

The GitHub design team always does a good job, so i suggest to do it as they to.

Screenshot from 2021-04-26 17-34-22

Show hints for readme and license with option to create them in webui.

Content should contain:

  • readme helps viewers to understand what a project is about, how to use it and how to contribute
  • an open source license makes it legally possible for people to use the project
  • write as Call To Action (like github did)
  • keep it short

I'm not a native speaker, so suggestions welcome.

@jolheiser
Copy link
Member

For what it's worth, if/when implemented I would like it to be configurable.

I can definitely see why Codeberg would want this, however I can also see where many smaller instances would just see clutter.

@fnetX
Copy link
Contributor

fnetX commented Apr 26, 2021

Well, actual downstream suggestion was actually to have a way to add a licence via such a convenient menu as you have on repo creation ... but we were also heavily discussing reminders for every bit and piece ...

The first one would already be an improvement without suggesting a specific use case for all the self-hosting Gitea users.

@jolheiser jolheiser added the type/proposal The new feature has not been accepted yet but needs to be discussed first. label Apr 26, 2021
@wULLSnpAXbWZGYDYyhWTKKspEQoaYxXyhoisqHf
Copy link
Contributor

wULLSnpAXbWZGYDYyhWTKKspEQoaYxXyhoisqHf commented Apr 28, 2021

For what it's worth, if/when implemented I would like it to be configurable.

always +1 for configurability

EDIT: nice idea btw @davidak

@lunny
Copy link
Member

lunny commented Apr 28, 2021

I agree with that. Well document is a basic of repository whether it is open source. The hint to create a readme is just a hint and when click it to go to the web editor and fill in the README.md in path input box.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/proposal The new feature has not been accepted yet but needs to be discussed first.
Projects
None yet
Development

No branches or pull requests

5 participants