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

update readme and add a contributing.md file #128

Merged
merged 2 commits into from
Feb 29, 2024

Conversation

C-Loftus
Copy link
Contributor

The previous readme did not specify that cargo run, cargo fmt and cargo clippy should be passing locally before committing. This may be obvious to those who are experienced in the Rust ecosystem, but for those who are not it is useful to specify and makes it easier for new contributors to quickly get up to speed.

I moved the information regarding flame graph as well into the contributing file, since it is likely not relevant for most users unless they are contributing. Finally, I chose to choose the name CONTRIBUTING.md instead of HACKING.md since CONTRIBUTING.md is more standardized, and has a specific special icon support in visual studio code among other support. (I also feel like long term, having a file called HACKING can be scary for non-technical users, even though that isn't particularly relevant at the moment.)

Copy link

codecov bot commented Feb 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 14.30%. Comparing base (026b7f4) to head (c3abecd).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #128   +/-   ##
=======================================
  Coverage   14.30%   14.30%           
=======================================
  Files          17       17           
  Lines        1559     1559           
=======================================
  Hits          223      223           
  Misses       1336     1336           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@TTWNO
Copy link
Member

TTWNO commented Feb 29, 2024

Thanks for putting this together! LGTM!

@TTWNO TTWNO merged commit 935ebb1 into odilia-app:main Feb 29, 2024
11 checks passed
@C-Loftus C-Loftus deleted the contributing branch March 2, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants