Petebrink/doc eval criteria

[petebrink]

Closed previous pull request. Updated document contains additional modifications and the license.

[github-actions]

🪓 PR closed, deleted preview content from gh-pages

[reiterative]

This is looking good to go, but to satisfy the LF DCO requirements all commits need to be signed by the committer.

This is easy to remedy if you only have one commit, but because you have multiple commits on your branch you will need to use an interactive rebase.

Here are the steps to do this (assuming that you wish to squash all of your commits into a single commit):

1. Update your local repo to the latest refs from upstream (origin)

    git fetch

2. Rebase your branch onto the latest version of main from upstream

    git rebase origin/main

3. Use interactive rebase to 'squash' your commits (see notes below)

    git rebase -i origin/main

4. Sign the commit

    git commit --amend -s

5. Force push the changes upstream

    git push -f

Squashing all your commits in an interactive rebase

Running command 3 above will open a temporary file (.git/rebase-merge/git-rebase-todo) in your configured text editor, which looks something like this:

pick 592fa39 First Draft ELISA Criteria Evaluation doc
pick 8b58358 Updated with feedback
pick 71c1db9 Added Review Ratings section with ratings and explanations.
pick 4d10faa Added NA criterion, Added further checklist questions to cover all criteria.
pick 901e0da Updated with feedback from review.
pick ccc8d31 Final updates for first draft.
pick d36a072 Added license.
pick 7b37489 Moved Evaluation Criteria document to the docs directory.
pick 723ea9b Added Document Criteria to main page.
pick 3d3698c Added Document Criteria to main page.

This is a list of all the commits on your branch, with the (short-form) commit hashes for each.

To 'squash' your commits into to a single commit

• Leave the first line unchanged
• Replace the pick designator at the start of each following line with s (or squash)
• Save the file and exit your editor

So for the above example, the updated temporary file would be:

pick 592fa39 First Draft ELISA Criteria Evaluation doc
s 8b58358 Updated with feedback
s 71c1db9 Added Review Ratings section with ratings and explanations.
s 4d10faa Added NA criterion, Added further checklist questions to cover all criteria.
s 901e0da Updated with feedback from review.
s ccc8d31 Final updates for first draft.
s d36a072 Added license.
s 7b37489 Moved Evaluation Criteria document to the docs directory.
s 723ea9b Added Document Criteria to main page.
s 3d3698c Added Document Criteria to main page.

Other interactive rebase alternatives

If you wanted to keep all (or some) of your commits, then you could instead change pick to 'r(orreword). This would allow you to edit each of the commit messages in turn and add a Signed-Off by: My Name [email protected]` line. You would also need to do this for the first line (or run commend 4 as above).

Or, you could use 'e' (or 'edit') to edit a commit, allowing you to run command 4 and then run the following to proceed:

    git rebase --continue

IMPORTANT NOTE

If you ever get into a mess with a rebase, you can abort it by running:

    git rebase --abort

This will take you back to where you started, with (hopefully) no harm done.

[reiterative]

@petebrink Note that I updated the previous comment to include:

5. Force push the changes upstream

    git push -f

I also added this to the Wiki (as a temporary home):

https://github.com/elisa-tech/wg-osep/wiki/Pull-Request-guidance

[reiterative]

The updated PR branch looks good to me. My only niggle is that the commit message now contains all of the accumulated history of changes from the squashed commits. I typically remove these and simply have one message describing the resultant set of changes contained in this commit.