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
Comments on the Gaphas documentation #47
Comments
Thanks so much for all of your time an effort helping us improve our README, that is awesome ❤️ The way GitHub gives credit for things is based on commits you make through a Pull Request. It looks like you have made some commits to projects in the past, would you be interested in submitting a PR with your proposed changes? If that would interest you, I would be glad to help you accomplish that. I thought I would also respond to your comments directly in the issue to make the discussion more open, I hope that is OK for you.
I think adding a hyperlink is a great idea. Also GTK dropped the + from their name, so we should fix that as well.
Yes, maybe we could explain this better. Gaphas was created as a library to allow others to create a diagramming tool using GTK and Cairo.
Yes, great idea!
Good point, maybe we could use a friendlier link like from the virtualenv docs or from the Hitchhiker's Guide to Python.
We did include installation instruction in the Gaphor README for macOS, I agree that we missed that and we should add it.
I never really thought about that before. I guess that would be useful 👍 |
Hello danyeaw, That is awesome that my comments helped you. I am not aware of the GitHub credit. Yes, definitely I would like to raise a PR. Let me know how to proceed. Thanks! |
I think Digital Ocean's Pull Request Tutorial is well done, and you'll appreciate that it is written by a technical writer. 😄 General steps:
If you get stuck on any of these steps, I would be glad to help you either on Gitter or I can even setup a video conference with you if needed. |
Hello Dan, I have done until step 6. In order to do a PR, I should first see the change in README. I am not able to see my changes at all. Please let me know what I am doing wrong or missing? |
Hello Dan, I was able to see the changes and I have submitted the PR. Please review. |
Closed by #48. 👍 |
Hello Dan,
As discussed earlier, here are my review comments on Gaphas docs. I hope you find them useful.
If you find anything that is not clear, please do ask. Also, ignore if I did any mistakes.
The latter part of my document you will find just the grammatical correction on the content. I hope you find the corrections.
Thanks!
Janet
Gaphas.docx
The text was updated successfully, but these errors were encountered: