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 design considerations #75

Merged
merged 1 commit into from
May 2, 2024
Merged

Conversation

lognaturel
Copy link
Member

Closes #10

What has been done to verify that this works as intended?

This mostly inserts the notes from the issue. It feels like they've stood up well through the functionality we've added recently!

Why is this the best possible solution? Were any other approaches considered?

I feel like this matches what we've been considering as part of API design but it's only good if @lindsay-stevens agrees!

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

None.

Do we need any specific form for testing your changes? If so, please attach one.

No.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

It is!

Before submitting this PR, please make sure you have:

  • included test cases for core behavior and edge cases in tests
  • run python -m unittest and verified all tests pass
  • run ruff format pyxform tests and ruff check pyxform tests to lint code
  • verified that any code or assets from external sources are properly credited in comments

@lindsay-stevens lindsay-stevens merged commit 1b8e871 into getodk:master May 2, 2024
4 checks passed
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.

README: add goals and how we think about design
2 participants