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

Document how to run tests and how to contribute #474

Open
ansasaki opened this issue Sep 1, 2023 · 3 comments
Open

Document how to run tests and how to contribute #474

ansasaki opened this issue Sep 1, 2023 · 3 comments
Assignees

Comments

@ansasaki
Copy link
Contributor

ansasaki commented Sep 1, 2023

Document in the README (or similar location) instructions on how to run tests and how to contribute.

This should lower the barrier for contributors to learn how to provide tests for their changes.

@kkaarreell
Copy link
Collaborator

Hi @ansasaki , we already have
https://github.com/RedHat-SP-Security/keylime-tests/blob/main/TESTING.md
Could you please take a look and maybe point out things that are missing or are too "difficult" to use?
I know there are some parts that are possibly outdated too.

@ansasaki
Copy link
Contributor Author

I think linking or including the TESTING.md file from the README.md would be sufficient to cover the testing part.

I think it would be good to provide a guide for contribution (instructions on the organization, where to put new tests, and a checklist), maybe in a CONTRIBUTING.md or directly in the README.md.

@kkaarreell
Copy link
Collaborator

The TESTING part should be covered by #488

@kkaarreell kkaarreell self-assigned this Sep 13, 2023
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

No branches or pull requests

2 participants