Skip to content

Add pre-contributing just recipe #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.

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

Merged
merged 1 commit into from
Dec 26, 2024
Merged

Add pre-contributing just recipe #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,9 @@ Here's some Guidelines:
- Has to run.
- Use [pre-commit](https://pre-commit.com/) for the language that you're using (if possible 👍).

You can accomplish that using our flake.nix for development.
You can run `just pre-contributing` to make it easier to check everything is correct before opening a pull request.

You can also accomplish that using our flake.nix for development.

## Developing on Floresta with Nix

Expand Down
3 changes: 3 additions & 0 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,6 @@ test-features arg="":
# Remove test-generated data
clean-data:
./contrib/clean_data.sh

# Run all needed checks before contributing code
pre-contributing: lint fmt test build-release
Copy link
Contributor

Choose a reason for hiding this comment

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

I would do this instead, as the lint recipe includes formatting, and test-features is the full check run in GitHub Actions.

Suggested change
pre-contributing: lint fmt test build-release
pc: lint test-features

Loading