-
Notifications
You must be signed in to change notification settings - Fork 0
User Acceptance Criteria v1
This page contains links to documents listing User Acceptance Criteria (UACs) for releases of Keep Network products developed across multiple keep-network repositories.
Everybody has a view access, only members of Keep organisation are allowed to edit.
- Release 2021-01-01 - Coverage Pools: view, edit
- Release 2020-01-01 - Feature 1, Feature 2: view, edit
[TODO: how to communicate the best which components were released?]
To edit existing UACs documents you must be a member of Keep organisation and must be logged to Google Sheets with your @keep.network account.
The list of UACs stored in the document is intended to evolve over time. Initial set of UACs will be defined after (or during) work on a new RFC. As RFCs not always reflect the final design, it is understandable that the list of UACs may need to get modified to reflect the changes in the requirements. Also, granularity of the UACs may increase with time as team gets more information on the design decisions made during feature development.
Developers working on the implementation of new functionalities and submitting a new PR should think of the list of PR-specific UACs and include them in the PR description. Once reviewed by the reviewer, UACs should get included in the UAC Google Sheet tab corresponding to the modified feature. Status of the UAC should be marked in the Before the merge to main column. UACs for PRs which are not tied to a bigger new functionality should be combined in a separate tab.
[TODO: what if the PR changes old code for which we don't have the UACs doc?]
You can use following template as a base when creating a Google Sheet document with UACs for a new feature: UACs Template.
Log in from your @keep.network account and save the template under different name (UACs - <feature name>).
Set correct permissions:
- Only users from Keep organisation can edit ( -> -> )
- Get shareable link ( -> -> )
- Edit the User Acceptance Criteria Wiki page to include the name of the new feature and link to the Google Sheet with UACs