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

Add a guide to the steps to be run in local before opening the PR. #139

Open
asnimansari opened this issue Dec 12, 2024 · 1 comment
Open

Comments

@asnimansari
Copy link

Maybe it's good to list down to run the basic steps mentioned in the ci check so that a newcomer can ensure those checks are satisfied before committing.

Either the user can manually check this. Or we could add a git pre-commit or pre-push hook.
Pre commit hook might be a bit annoying as rust compilation takes time.

@elpiel
Copy link
Member

elpiel commented Dec 26, 2024

Thanks for raising the issue.

As a first step we should add Contributing.md and add the steps there.

Steps for adding new sentences should also be extended with:

  • the addition of adding a new feature
  • adding the sentence to the all_sentences list
  • documentation in lib.rs
  • documentation in README.md

We should also update the README.md as it doesn't include all the steps currently

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants