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

Update README.md #5179

Merged
merged 1 commit into from
Dec 21, 2020
Merged

Update README.md #5179

merged 1 commit into from
Dec 21, 2020

Conversation

rmzelle
Copy link
Member

@rmzelle rmzelle commented Dec 21, 2020

Update/replace https://github.com/citation-style-language/styles/wiki/Criteria-for-Accepting-Styles.

@adam3smith, @bwiernik, I have the impression that in recent years, the READMEs on GitHub have become a more prominent source of information than a project's wiki. So I think it would make sense to move some parts of the wiki to the README, like this one. We can keep the wiki around for more esoteric information.

@rmzelle
Copy link
Member Author

rmzelle commented Dec 21, 2020

(and I think the README of https://github.com/citation-style-language/styles/ traditionally has been very bare-bones, so I'm trying to spruce it up a bit)

@bwiernik
Copy link
Member

This is a great idea

@rmzelle rmzelle merged commit aa5ba1c into master Dec 21, 2020
@rmzelle rmzelle deleted the readme-criteria-for-inclusion branch December 21, 2020 23:15
@bwiernik
Copy link
Member

How about we also:

  1. Move the style request page to a REQUESTING.md
  2. Move the various style editing/testing/development team to a STYLE_DEVELOPMENT.md

@rmzelle
Copy link
Member Author

rmzelle commented Dec 30, 2020

Sure.

Note that neither of those files seems to be a special file for GitHub, but that shouldn't be a deterrent I think, and we shouldn't overload README. See https://github.com/joelparkerhenderson/github_special_files_and_paths and https://github.com/kmindi/special-files-in-repository-root/blob/master/README.md.

@bwiernik
Copy link
Member

@rmzelle @adam3smith could one of you give me wiki editing privileges so that I can copy the markdown syntax out?

@adam3smith
Copy link
Member

adam3smith commented Dec 30, 2020 via email

@bwiernik
Copy link
Member

Thanks that worked. Opened a PR

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

Successfully merging this pull request may close these issues.

3 participants