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

Add a CONTRIBUTING file #326

Open
ilai-deutel opened this issue Nov 13, 2024 · 1 comment
Open

Add a CONTRIBUTING file #326

ilai-deutel opened this issue Nov 13, 2024 · 1 comment
Labels
developer-experience Improve the experience of kibi contributors documentation Improvements or additions to documentation

Comments

@ilai-deutel
Copy link
Owner

ilai-deutel commented Nov 13, 2024 •
edited
Loading

The contributing guide should include:

  • How to build and run kibi locally
  • Guidelines for testing / code coverage
  • How to run unit tests, count lines, fmt, clippy, fuzz tests
  • Optionally: how to run local code coverage
@ilai-deutel ilai-deutel added documentation Improvements or additions to documentation developer-experience Improve the experience of kibi contributors labels Nov 13, 2024
@joshka
Copy link
Contributor

joshka commented Nov 13, 2024

With the cargo xtask approach in #328, a lot of this becomes:

cargo xtask <some command>

with command line help easily available with cargo xtask --help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
developer-experience Improve the experience of kibi contributors documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@joshka @ilai-deutel