Closed
Conversation
aditsuru
requested changes
Sep 29, 2025
Contributor
There was a problem hiding this comment.
Several changes are needed.
The main problem is the writing style. It uses too many references and too much formatting, and it doesn’t clearly explain how to actually add the feature to our app. Right now, it focuses on the GitHub API itself, not on how it fits into our app.
Other small issues:
- It talks about a point system but doesn’t explain what it is or why it matters for our project.
- There are too many “[1]” references.
Suggestions:
- Write it clearly in your own words, like a guide for other developers.
- Focus on our project. Explain not just the endpoints, but how we will use them. For example, if some endpoints are not needed, say: “We will use a simple Python library that handles the requests for us.”
You can check this link to see an example of the writing style we want.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
📝 Description
Related Issues
Closes #16
🚀 Type of Change