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

Jump to bottom

Improve Quality of Documentation #64

Closed
0xTheProDev opened this issue Oct 3, 2021 Discussed in #63 · 0 comments · Fixed by #65
Closed

Improve Quality of Documentation #64

0xTheProDev opened this issue Oct 3, 2021 Discussed in #63 · 0 comments · Fixed by #65
Labels
Hacktoberfest Hacktoberfest Participation Small Story Point
Milestone
S-41-43

Comments

@0xTheProDev
Copy link
Owner

Discussed in #63

Originally posted by lapstjup October 3, 2021
Hi @Progyan1997 , I was going through the CONTRIBUTING.md for this project and found subtle grammatical nuances that I think can be corrected. Also the README link in the same redirects to 404 Page. Since the guidelines state that an issue shouldn't be opened up by a user until a maintainer picks it from discussions and these kind of changes don't fall under bug report, can I proceed with creating an issue and submitting a PR that addresses it ?

BTW, this is a really cool project 💯 . I haven't really worked in the same space so the code is new but interesting. I think a diagrammatic workflow would be good addition to README as well so that new comers can familiarize themselves quickly with terminologies like "Operational Transformation", "Editor Adapters" and "Database Adapters".

Out of Scope: Diagrams and further analysis.
@0xTheProDev 0xTheProDev added Hacktoberfest Hacktoberfest Participation Small Story Point v0.2.0 labels Oct 3, 2021
@0xTheProDev 0xTheProDev added this to the Product Backlog milestone Oct 3, 2021
lakbychance added a commit to lakbychance/Operational-Transformation that referenced this issue Oct 3, 2021
@lakbychance
docs : Update CONTRIBUTING markdown file
73c8e4c 
The CONTRIBUTING markdown file is updated with correct link(s) to relevant files and linguistic corrections. 

Fixes: 0xTheProDev#64 
Signed-off-by: Lakshya Thakur lapstjup@gmail.com
@0xTheProDev 0xTheProDev modified the milestones: Product Backlog, S-41-43 Oct 3, 2021
@lakbychance lakbychance mentioned this issue Oct 3, 2021
Merged
0xTheProDev pushed a commit that referenced this issue Oct 3, 2021
@lakbychance
(docs) Contributing Guidelines: Update Contributing.md file
aa2b837 
The CONTRIBUTING markdown file is updated with correct link(s) to relevant files and linguistic corrections. 

Fixes: #64 
Signed-off-by: Lakshya Thakur lapstjup@gmail.com
Repository owner locked as resolved and limited conversation to collaborators Oct 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Hacktoberfest Hacktoberfest Participation Small Story Point
Projects
None yet
Milestone
S-41-43
1 participant
@0xTheProDev