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 Contributing guidelines #544

Merged
merged 4 commits into from
Nov 5, 2022

Conversation

Terseus
Copy link
Collaborator

@Terseus Terseus commented Nov 5, 2022

Adds a first version of the contributing guidelines with information of how to use and maintain the test suite.

Some side changes made while documenting the test suite usage:

  • Create the requirements.txt file to ease the environment setup.
  • Create the mocked_responses fixture as a central point to configure responses.
  • Rename tests to prevent name clashing, just to be able to use pytest -k with them without executing other tests.

Now we can install the library dependencies without having to install
the library itself, useful for development.
Now all the tests that use it will automatically assert that all the
requests are made.

It may also serve as a single point where we can configure more global
behavior of `responses`.
It just adds an `_ok` prefix to tests that are not specialized (e.g.
doesn't test specific parameters) to being able to use
`pytest -k <test name>` with them without executing more than one test
if we want.
@emlazzarin emlazzarin merged commit d30adbd into GeneralMills:master Nov 5, 2022
@emlazzarin
Copy link
Collaborator

Looks good to me.

@Terseus Terseus deleted the contributing-guidelines branch November 5, 2022 20:29
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