Community Standards

[real-yfprojects]

I would like to improve our community standards by adding the following. Feel free to add stuff or tell me if you don't like something. We will definitely have to discuss what to do for each point. We could open follow-up issues for that.

• [ ] #30
• [ ] Consistency
  • [ ] Consistent wording (e.g. complain instead of error)
  • [ ] #34
• [ ] Contributing.md
  • [ ] Move existing contributing guide to that file
  • [ ] Improve on it where applicable (e.g. setup dev env)
  • [ ] Contributing Rules
    • [ ] Code style
    • [ ] Commit and branch style
    • [ ] Workflow and process
    • [ ] Rules for version numbers
    • [ ] Issue+PR label system
• [ ] Maintaining docs
  • [ ] Vision & Current stage
  • [ ] Roadmap
  • [ ] Workflows
  • [ ] Rules
• [ ] Add badges to readme
• [ ] CI
  • [ ] Linter checks
  • [ ] Automation (e.g. publish to pypi on release, stale issues, thanking contributors, messages based on label/status)
• [x] #33

[akaihola]

What does "Contributing.md / Consistent wording / complain instead of error" refer to?

Could you explain in more detail what is meant by the four items under "Maintain documents"?

What would be the github.com subdomain for hosting the documentation?

[real-yfprojects]

What does "Contributing.md / Consistent wording / complain instead of error" refer to?

I think it would be better to use the term complain instead of 'errors' when talking about the problems represented by error codes (e.g. DAR102).

Could you explain in more detail what is meant by the four items under "Maintain documents"?

Documentation about maintaining the repository, so that every one can continue maintaining the repo by reading it when we are abducted by aliens XD.

What would be the github.com subdomain for hosting the documentation?

That would be https://github.com/akaihola/darglint2. There is no way to change that without buying an external domain name afaik.

[akaihola]

complain instead of 'errors'

Ah, so "Error codes" would become "Complaint codes". I get your point. Maybe it's worth checking what terminology other popular Python linters use and align with them if possible.

Documentation about maintaining the repository

Good idea. Although I wouldn't consider creating these items as the first priority as long as we have just two contributors.

That would be https://github.com/akaihola/darglint2.

You probably mean https://akaihola.github.com/darglint2? I haven't created GitHub Pages for project documentation before – how would it work if I want to also add documentation for e.g. Darker and Graylint under the same subdomain?

[real-yfprojects]

I wouldn't consider creating these items as the first priority as long as we have just two contributors.

One the one hand you are right, on the other its best to start documenting early or else one will never do it.

You probably mean https://akaihola.github.com/darglint2? I haven't created GitHub Pages for project documentation before – how would it work if I want to also add documentation for e.g. Darker and Graylint under the same subdomain?

Yeah right. Regarding your other projects, let me quote the docs:

The source files for a project site are stored in the same repository as their project. Unless you're using a custom domain, project sites are available at http(s)://<username>.github.io/<repository>

[real-yfprojects]

One the one hand you are right, on the other its best to start documenting early or else one will never do it.

Furthermore such documentation is useful for returning to a project after a break and it sets expectations for and gives context to new contributors.

[akaihola]

The source files for a project site are stored in the same repository as their project. Unless you're using a custom domain, project sites are available at http(s)://<username>.github.io/<repository>

Brilliant! And there seems to be a GitHub Action for publishing Sphinx documentation into GitHub Pages: https://github.com/marketplace/actions/sphinx-to-github-pages

I'm all for starting with follow-up issues for each of the items you listed.