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.

Sign up for GitHub

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 documentation of Makefile #249

Merged
merged 3 commits into from
Jul 15, 2024
Merged

Improve documentation of Makefile #249

merged 3 commits into from
Jul 15, 2024

Conversation

fpgmaas
Copy link

@fpgmaas fpgmaas commented Jul 15, 2024

Proposed changes

Improve documentation of Makefile to reduce risk of the make help command running out of sync with the actual commands in the future. Running make help will show:

install_test         Install test dependencies
install_deps         Install all dependencies
update_deps          Update dependencies
test                 Run the unit tests
lint                 Lint the code
format               Format the code
help                 Show help for the commands.

@fpgmaas fpgmaas changed the base branch from main to planning-1.0-release July 15, 2024 08:04
SemyonSinchenko
SemyonSinchenko approved these changes Jul 15, 2024
View reviewed changes
Copy link
Collaborator

@SemyonSinchenko SemyonSinchenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@SemyonSinchenko SemyonSinchenko merged commit 1710e6e into mrpowers-io:planning-1.0-release Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SemyonSinchenko SemyonSinchenko SemyonSinchenko approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fpgmaas @SemyonSinchenko