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

starts work on additional states #238

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

niquerio
Copy link
Collaborator

✋  Wait!

Let's make sure your pull request is ready. Ask yourself...

✅  "Did I do a good job testing my own code?"
✅  "Is my code easy to read and understand?"
✅  "Have I written unit tests? Do the unit tests fully cover my code?"
✅  "Have I tested the repository's behavior to make sure my code didn't break anything?"
❎  "Did I include unrelated work that could be in its own pull request?"

Once you are ready, be sure to delete this details section before opening your pull request.

Overview

Talk about the intent and scope of the original issue. Go over the general changes that have been made between this branch and the branch the pull request will merge into. Displaying screenshots can help!

Add links to any documentation or issues that can help give more background information. Is the pull request related to a GitHub or JIRA issue? Link to them while using closing keywords, like so:

This pull request resolves/closes/fixes LIBSEARCH-1234.

Anything else?

Optional. If appropriate, provide additional notes the reviewers should be made aware of. They can be about any "gotchas" or even changes that are expected to be made in the future, but are not applied to this pull request.

Testing

List instructions on how to test the pull request. Some examples:

  • Run the tests to make sure they pass (docker-compose run --rm web bundle exec rspec).
    • Break the new/updated unit tests to make sure they're working properly.
  • Make sure the PR is consistent in these browsers:
    • Chrome
    • Firefox
    • Safari
    • Edge
  • Run accessibility tests:
    • WAVE
    • ARC Toolkit
    • axe DevTools
  • How to use the feature.

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.

1 participant