-
Notifications
You must be signed in to change notification settings - Fork 95
Improve docs about how to run dev tools #319
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
Merged
hongquan
merged 3 commits into
fossasia:development
from
hongquan:feature/doc-on-running-dev-tools
Mar 31, 2025
Merged
Improve docs about how to run dev tools #319
hongquan
merged 3 commits into
fossasia:development
from
hongquan:feature/doc-on-running-dev-tools
Mar 31, 2025
Conversation
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
Reviewer's Guide by SourceryThis pull request introduces a Flow diagram for using justfileflowchart LR
subgraph Using justfile
A[Edit files] --> B{Run just command}
B --> C{Execute command defined in justfile}
C --> D[Result of the command]
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @hongquan - I've reviewed your changes - here's some feedback:
Overall Comments:
- It might be worth mentioning
justin the README or a contributing guide so developers know how to use it. - Consider adding a comment to the
justfileexplaining why each command is useful for development.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Follow #318.
This PR adds a guide about how to run lint tools.
Because the command is long, I introduce a
justfileto let run shorter command.For why not use Makefile, there is an explanation.
How has this been tested?
Checklist
Summary by Sourcery
Add a justfile to simplify developer tooling commands and improve documentation for running development tools
New Features:
Documentation:
Chores: