Skip to content
This repository has been archived by the owner on Jul 30, 2022. It is now read-only.

Housekeeping #33

Closed
4 tasks done
Hutchy68 opened this issue Apr 27, 2017 · 6 comments
Closed
4 tasks done

Housekeeping #33

Hutchy68 opened this issue Apr 27, 2017 · 6 comments

Comments

@Hutchy68
Copy link
Owner

Hutchy68 commented Apr 27, 2017

Couple of housekeeping tasks

  • Rename COPYING to LICENSE? GitHub will add the license type to the top of the repository if it finds LICENSE in the root. Unless you specifically set the license file when the repository is created, COPYING will never be picked up as the alternate LICENSE file. LICENSE or COPYING works with MW when clicking on the license link under Special:Version. Example of a (MIT) license icon. GitHub should pickup the LICENSE and its text, then put the appropriate license type on the repository.
    image
  • Add a CONTRIBUTING.md file. Keep it simple.
  • Add a PULL_REQUEST_TEMPLATE.md. Keep it really simple.
  • Use the .github directory. GitHub will detect template files in the .github hidden directory. Put CONTRIBUTING.md, PULL_REQUEST_TEMPLATE.md, and (thanks to @kghbln) the ISSUE_TEMPLATE.md.
@kghbln
Copy link
Contributor

kghbln commented Apr 27, 2017

Rename COPYING to LICENSE?

I think this is a rather significant shortcoming of @github and a bug not to support COPYING. Actually it is defying reality. While MediaWiki supports both file names COPYING is probably used by 99%+ of all extensions including MediaWiki core. (see also in general on this) In the end however it is just a matter of personal taste since both should be understood.

@Hutchy68
Copy link
Owner Author

I wonder if it's a feature request. Actually I wonder if it matters having both. Seems a little redundant though.

@Hutchy68
Copy link
Owner Author

Hmm, editing the COPYING file directly did pick up it is a LICENSE type file. The icon at the top still isn't showing but I wonder if it is a timing thing with GitHub.com. I'll wait and see.

@Hutchy68
Copy link
Owner Author

Testing, I figured out what GitHub.com wants to see. Any variation and detection fails.

@kghbln
Copy link
Contributor

kghbln commented Apr 27, 2017

Testing, I figured out what GitHub.com wants to see. Any variation and detection fails.

Good on one hand since standards are enforced. Bad since you have to find other way to credit over time. So the variation should perhaps be done in README.

This was referenced Apr 28, 2017
@Hutchy68
Copy link
Owner Author

Closing and opening a new issue specific to how to license with attribution in BSD-2 see #37

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants