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

Define guidelines #65

Closed
ctmbl opened this issue Jun 3, 2024 · 0 comments · Fixed by #91
Closed

Define guidelines #65

ctmbl opened this issue Jun 3, 2024 · 0 comments · Fixed by #91
Labels
enhancement New feature or request help wanted Extra attention is needed tooling Improvements or additions to tooling, automation, practicality...
Milestone

Comments

@ctmbl
Copy link
Contributor

ctmbl commented Jun 3, 2024

As introduced with #58 (comment) it's time to deal with Guidelines

Ideas in no particular order:

  • CONTRIBUTING.md
  • how to write a good title, a good summary
  • naming guidelines for article files (upper case, dash/underscore, length, keyword) to produce consistent and informative URLs
  • specials file name and title format for write up
  • non-exhaustive set of tags to control tag proliferation
  • tag rules (upper case, length,...)
  • non-english articles: tags, title (see Add language in title when not in English #63 )
  • enforce rules or check them through workflow

this must be discuss and order before starting a pull request

@ctmbl ctmbl added enhancement New feature or request help wanted Extra attention is needed tooling Improvements or additions to tooling, automation, practicality... labels Jun 3, 2024
@ctmbl ctmbl added this to the v0.5 milestone Aug 31, 2024
@ctmbl ctmbl linked a pull request Oct 15, 2024 that will close this issue
@ctmbl ctmbl closed this as completed in #91 Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed tooling Improvements or additions to tooling, automation, practicality...
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant