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

Please review docs about Schleuder and related projects #50

Closed
geor-g opened this issue Jul 19, 2018 · 3 comments
Closed

Please review docs about Schleuder and related projects #50

geor-g opened this issue Jul 19, 2018 · 3 comments

Comments

@geor-g
Copy link

geor-g commented Jul 19, 2018

Hi,

We would like to ask for a review of the docs of Schleuder, a GPG-enabled mailing list manager with resending capabilities, and related projects:

Thanks in advance, and for your work.

Cheers,
Georg

@LappleApple
Copy link
Owner

Thanks for the submission. :)

@LappleApple
Copy link
Owner

Hiya: Finally had a chance to take a look at your Readme -- per the Readme for this project, full docs reviews aren't in scope. : ) Your Readme is pretty good! Here's what I liked:

  • states clearly at the top what it is/does
  • requirements section is prominent
  • lots of sensible links to sub-pages vs. storing everything in the Readme
  • points people to the contributing.md to encourage community

I might combine the Todo and Contributing sections, adding some contact info — including the link to this page would be sufficient. And on your mission statement page (like this a lot), you could elaborate on your governance model and decision-making processes to help contributors understand your ways of working.

@LappleApple
Copy link
Owner

Closing this issue as I provided a response. Feel free to reopen if necessary. :)

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

No branches or pull requests

2 participants