lappleapple / feedmereadmes Goto Github PK

Hi,

This is my first open source project. I have written a lightweight UML state machine framework in C for embedded system developers. It would be really grateful if you review my project readme and suggest improvement.

https://github.com/kiishor/UML-State-Machine-in-C

Thanks in advance,
Nandkishor

Hi !

Thank you very much for proposing this, it will be very useful to the whole open-source world.

Could you give a look at the readme of the chemfiles library: https://github.com/chemfiles/chemfiles?

The project intended audience is scientists who are not necessary developers, put are putting together small scripts/programs for research. I'm not telling more, I hope the README can explain the rest =)

Thank you very much !

Thank you for the work you guys do to help the community make everything better. I would like some assistance with the README I have for one of my projects. Please take a look at https://github.com/ubiety/Ubiety.Dns.Core#readme

Hi! I just stumbled upon "maker of @feedmereadmes" at https://twitter.com/LauritaApplez and think it's a great idea to encourage projects to give and receive feedback on READMEs. I'm especially interested in the README maturity model you've come up with.

From what I understand I'm supposed to create an issue and link to my project's README and ask for feedback. Please take a look at the README at https://github.com/IQSS/dataverse and let me know what you think! Thanks!

(I wish I had know about Feedmereadmes before today because I just gave a talk last week about open source and would have mentioned it!) 😄

https://github.com/emmanix2002/erlang_postmarkapp/blob/master/README.md

Hi @emmanix2002, here's where I've added your project. Thanks for submitting it!

I'd appreciate a review on cockatrice: https://github.com/cockatrice/cockatrice/

Hi, I just spent a lot of effort completely revamping the README for Gaphas. I would very much appreciate some feedback to help me further sharpen the why, how, and what, and of course any other feedback would be awesome as well. ❤️

I was so excited to see your project! What a fabulous idea. I would be interested in some feedback on the Sprig project's README.

https://github.com/Masterminds/sprig/blob/master/README.md

Thank you!

Feel free to have a go at the README.md (and other .md files) of iText:

https://github.com/itext/itext7

Some of the files have a very long history, which isn't reflected by the Git history, because they used to be .txt files. Also, we used SVN in prehistoric times, see https://sourceforge.net/p/itext/code/HEAD/tree/trunk/itext/ (scheduled to be deleted)

amzn/oss-dashboard#101 (comment)

https://building.buildkite.com/we-did-a-week-entirely-dedicated-writing-and-you-should-do-one-too-5fbbae480a56

Saw your article on opensource.com

It's not on Github, but Gitlab accepts Github logins:
https://gitlab.com/trashy/trashy

With links:

• http://www.ybrikman.com/writing/2014/05/05/you-are-what-you-document/
• https://www.hanselman.com/blog/BringKindnessBackToOpenSource.aspx
• How to Write Documentation for People that Don't Read: https://www.youtube.com/watch?v=sQP_hUNCrcE
• http://hilton.org.uk/presentations/documentation
• http://codewerdz.org/
• https://insights.hpe.com/articles/how-to-write-documentation-thats-actually-useful-1707.html
• http://codewerdz.org/
• http://blog.izs.me/post/161633971373/documentation-driven-development
• Andrea Goulet: Communication is Just as Important as Code: https://www.youtube.com/watch?v=VFuNdKPV0jc&feature=youtu.be
• https://www.youtube.com/watch?v=sQP_hUNCrcE
• Slides: kev.inburke.com/slides/documentation

Would really welcome your advice on this readme! Thanks.

https://github.com/VGraupera/manager-resources

I've been trying to make the documentation for my project clear but would appreciate some feedback (especially as someone commented the Readme wasn't good enough

https://github.com/takeoff-env/takeoff is the main repo (which also drives the documentation on https://takeoff.sh via github pages, but the Readme is the index and the "hook" for people). This is the main tool I'm publishing.

It also ships with blueprints which include their own documentation and the default blueprint is here https://github.com/takeoff-env/takeoff-blueprint-basic

Hi,

first of all, thanks for this initiative! I think explicitly getting feedback on project documentation is an awesome idea.

As for the actual help request: It would be lovely to get feedback for the following readme:

https://github.com/apache/mahout/blob/master/README.md

Please note that while I'm part of the group of committers listed for this project, me posting this issue here is my personal initiative. So when posting feedback it might be worthwhile to let people know that I'm the one to blame for seeking input.

As an additional note, people on our project are right now working to improve the documentation and website. So in case of time left, feedback on the progress made there, as well as on how easy it is to find that progress as a new motivated contributor would be highly appreciated.

Thanks again,
Isabel

Hi Lauri,

I'd be happy to hear what you think about the README of failsafe-actuator?.

Best,

Malte

Finishing up a blog post to go with this repo, I'd love to have some feedback:

https://github.com/GantMan/ReactStateMuseum

I will link to the blog post when it is published, of course!

Hi,

I would like to ask for a review of the multilanguage readmes of Spring Cloud example, a hello-world app written entirely in Kotlin. This app is for demonstrating / learning Microservices architecture.
Thanks in advance for your work!

Cheers,
Paul

I have created a new project which I have published on GH. I would appreciate your feedback on the README

Thanks!

Hi there, thanks for taking a look!

I would love some feedback on my README for my own project.
https://github.com/Ruben2776/PicView

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:

• https://0xacab.org/schleuder/schleuder
• https://0xacab.org/schleuder/schleuder-cli
• https://0xacab.org/schleuder/schleuder-web
• https://0xacab.org/schleuder/schleuder-website

Thanks in advance, and for your work.

Cheers,
Georg

Node Serialport is a widely used nodejs serialport library. I have users from all languages and countries, a lot of people new to javascript development and software development as a whole. To make it even more interesting we have at least 3 versions of serialport in wide use and the very old ones have a lot of bugs.

I have a few goals;

• Making sure non english speakers can approach the documentation.
• Making sure people can find and understand the installation guides, as a lot of support issues are solved by linking people to the docs.

https://github.com/EmergingTechnologyAdvisors/node-serialport

Hi @LappleApple ,

one of the projects of the Italian Digital Transformation Team is to build a set of API that will be used by government agencies as the foundation for their digital services.

We're currently working on the first iteration of these APIs that will provide:

• a communication interface for sending messages to citizens through several digital channels (initially e-mail and SMS)
• a repository of user preferences that citizens can set and that services can read to deliver personalized experiences to the citizens

This is the main repository of the APIs code, with the README (the audience is toward contributors and service developers).

Thanks in advance for the feedback! ❤️

Thanks for offering this fantastic service Lauri and gang!

We would love input, critiques, and edits of our README page (and all other documentation in the project for that matter) for the Hack project and highly encourage participation in the project by any interested technical writers out there. We are definitely open to contributions from those who have never contributed to open source projects and would like to experience the workflow/interactions with development teams and the community around a project.

https://github.com/source-foundry/Hack/blob/master/README.md

Please let us know how we can assist any writers with the contribution process beyond the documentation that you provide here. They are welcome to open new issue reports on the repository for anything that they would like to discuss (prior to or during work on the docs) and submit pull requests with their edits. Our CONTRIBUTORS.md page includes our documentation contributors and writer participation in the project will be acknowledged there irrespective of whether they commit changes or would like to work via issue reports with our team making the repository modifications (though it would be to their benefit to learn the former path if they are unfamiliar with it and intend to broaden their OS project participation).

Thanks again and let us know how we can be of help!

Would love to get some feedback on https://github.com/aerupt/dollars/blob/master/README.rst as well. Tried to keep it minimal.

I'd love some feedback on how to keep the documentation more clear and concise!

https://github.com/StarChart-Labs/flare-operations-plugins

Submitted by @romeara

Opening a project's wiki to any registered user can open a breeding ground / incubator for catching ideas in raw form and polishing them for inclusion into the "official" documentation. It fosters collaboration much more so than the rigid time-line format of an issue thread, and potentially lowers the threshold for new contributors.

Like in this project, where you could have a page to discuss improvements of the "Inspiration" page. 😉

A README should link to the wiki, and explain what it's main purpose is (main docs, experiments / drafts, …).

This is my project that is used from different people but I am not sure how much is easy to understand the readme.
https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered

Hey! I hope that I'm doing this right. We're not really free (beer), but I hope to get some help anyway. Saw Stephanie retweet it — awesome initiative.

https://github.com/radera/victory/blob/master/README.md

Hi,

We would like to ask for a review of the readme of FlubuCore, a cross platform build and deployment automation system for building projects and executing deployment scripts using C# code.

Thanks in advance, and for your work.

Hi! I manage the project for the community edition of a game, the upstream of which has stopped development. I'm a bit worried about the size of the README itself, even though the building process itself is quite complex and warrants the size. If you have any suggestions, it'd be much appreciated. Thanks!

Link

Hi, I just learned about this project/service -- it's a fantastic idea!

If you have the time, we'd love to have your feedback on the README of MapStruct: https://github.com/mapstruct/mapstruct. We spent quite some time on it originally, but since then it has aged a bit and I think there are a few opportunties for improvement. Any thoughts and input on that would be very much appreciated.

https://github.com/SoftInstigate/restheart

We'd love to read your feedback!

Hello Lauri!!! Our open source e project webpack has an extensive need for those who would like to help us review or write for our documentation page!!

Here is the issue you mentioned I should add to this issue tracker!!! webpack/webpack.js.org#1380

Hello,

It would be nice to get your feedback on https://github.com/xemul/criu

Thanks!
-- Pavel

cc @szczepiq, adding it to my queue.

Hi, I just spent a lot of effort completely revamping the README for Gaphor. I would very much appreciate some feedback to help me further sharpen the why, how, and what, and of course any other feedback would be awesome as well. ❤️

Figured why not ask.

Description

I have written, tested, documented, and linted several hundred data structures, algorithms, and coding problems in javascript.

https://github.com/williscool/code_gym/blob/es6ify/README.md

https://github.com/williscool/code_gym/blob/es6ify/javascript/js_README.md

Hi,

I would like to ask for a review of the readme of SoundRecorder, an Android application for audio recording written in Java. My goal is to create a simple and robust open source app.

Thanks in advance, and for your work.

Hey there!

I'm looking for feedback in the ffind README page.

Thanks a lot in advance! This is a great initiative

Cheers,
Jaime

Hey folks,

Thanks in advance for taking the time to look at this. I'm interested in feedback for Diesel's README. We also have a lot of stuff on our website diesel.rs, so the README Is intentionally a bit light. (Not sure if y'all are interested in reviewing websites as well)

First:

Thank you so much for offering this service! It's pretty fantastic!!

Second - Here's the GitHub project Readme that I would love some help with:

https://github.com/scrthq/Vaporshell/blob/master/README.md

Third - Background:

The Readme I have there is mainly a pointer towards the documentation site I build on top of GitHub Pages w/ a custom domain. I've been building VaporShell completely solo, down to the website design (http://vaporshell.io/), all of the source code, and any associated Readme's. It's the first project I've really done on this scale and is for a tool that I feel is a huge help to SysAdmin's working in AWS with CloudFormation / Infrastructure as Code in general. VaporShell itself is a PowerShell module designed to allow easy creation of CloudFormation templates by leveraging Powershell's featureset and syntax. This allows you to do things like tab-completion of valid values for specific parameters, tab completion of resource parameters in general (there are over 600 resource types available in CloudFormation with varying property sets between each one, so remembering all of those tends to be a little overwhelming), and many other things. Another key point for the project is cross-platform compatibility, now that PowerShell Core / .netcore is becoming a bigger focal point. All development and CI tests are done on both .NetFramework (Windows/AppVeyor) AND .NetCore (Ubuntu for local dev/testing, Ubuntu/macOS in Travis CI for CI integration)

Fourth - Plans for the near future:

v2.0.0 is coming soon (within the next month). Updates are geared around including full CloudFormation stack management (i.e. deploy/update/delete/monitor -- current iteration is template building only) via the .NET / .netcore SDK's from AWS

Thanks again for helping out OSS projects!

• Nate / SCRT HQ

Super interesting project.

I was hoping to see the before/after of some reviews somewhere, maybe links to issues or PRs created. Or to say it in the words of the maturity model:

[...] evidence of past performance in real development situations.

😄

Did I miss it or doesn't this exist (yet)?

https://github.com/hjacobs/kube-ops-view

requested by @hjacobs

I'd like to add the coala README to this :)
https://github.com/coala/coala/blob/master/README.rst

Thank you for this project!

Our project helps people manage and install different versions of Erlang. I know our README could use some editing and review.

I've been doing READMEs for a long time, and the one thing I've learned is that it can ALWAYS get better. I'm happy to hear and incorporate awesome feedback on my readme doc.

The project is planned to be officially released in about a week.
https://github.com/infinitered/solidarity