Skip to content
This repository has been archived by the owner on Mar 25, 2023. It is now read-only.

Update the contribution guide to include steps for running tests #11

Open
lawynnj opened this issue May 25, 2021 · 3 comments
Open

Update the contribution guide to include steps for running tests #11

lawynnj opened this issue May 25, 2021 · 3 comments

Comments

@lawynnj
Copy link

lawynnj commented May 25, 2021

The contributing guide (https://project-books.github.io/docs/contributing/) is missing steps on how to execute tests.

This would be helpful to contributors who are unfamiliar with the environment.

@lawynnj lawynnj changed the title Update the contribution documentation to include steps for running tests Update the contribution guide to include steps for running tests May 25, 2021
@knjk04 knjk04 transferred this issue from Project-Books/books-api May 25, 2021
@knjk04
Copy link
Member

knjk04 commented May 25, 2021

Thanks for creating this issue. I've transferred it over to this docs repository.

We may need separate instructions for running tests using Gradle (Books API) and Maven (Book Project). I think it would be good if we keep the contributing guide as short as possible, but perhaps we can link to a new 'How to' page that describes the steps. What do you think?

@lawynnj
Copy link
Author

lawynnj commented May 26, 2021

That sounds like a good idea. Makes sense to have separate instructions for the two projects. Do we intend on storing documentation for both projects in this docs repository long term?

@knjk04
Copy link
Member

knjk04 commented May 26, 2021

Initially, we created this repository to hold common documentation. We could maintain separate wikis, but one advantage of having separate documentation in this docs repository is contributors can look in one place for everything. What do you think?

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

No branches or pull requests

2 participants