update contributing file: how-to's, requirements, references, format

[avallecam]

list of actions

• add index or other feature to facilitate readability
  • from https://github.com/citation-file-format/citation-file-format#contributing-handshake
  • now in add index or other feature to facilitate readability of CONTRIBUTING #80
• add two review alternatives for reviewers
  • from define contribution roles for developers, reviewers, maintainers. #33 (comment)
  • solved in add md-output alternative to contributing #44
• add how-to steps for maintainers
  • from update contributing file: how-to's, requirements, references, format #35 (comment)
  • now in add steps on how to keep feature branch updated with main #81
• add the required development stage of package dependencies
  • from define contribution roles for developers, reviewers, maintainers. #33 (comment)
  • solved in define contribution roles for developers, reviewers, maintainers. #33 (comment)
  • solved in setup-lesson-deps can not handle universe or github packages carpentries/actions#32 (comment)
• add: Read issues labelled with to-keep read new features we want to keep in this repo.
  • now in add complementary writing guidelines #75
• add How to edit the workbench link https://carpentries.github.io/sandpaper-docs/editing.html
  • now in add complementary writing guidelines #75

[avallecam]

From feedback on #33 (comment)

[last update] After github response to the button in #55 (comment)

About:

tutorials/CONTRIBUTING.md

Line 128 in 969a11b

- Keep branches up to date with `main`.

Add these lines to maintainer and developer options:

• Keep branches updated with main. For this, follow these steps:
  • In a PR at the remote:
    • Go to the "Update branch" options,
    • Click the "Update with Rebase" option. Warning: Avoid the "Update with merge commit" option.
  • In the local repository:
    • Go to the terminal,
      • Run git pull origin main to rebase the feature branch.
    • Go to Git tab in the environments pane
      • Click on Pull options > Pull with rebase

Questions:

• Can the developer be also responsible for keeping its feature branch updated with main by running this locally? YES. we can also add this action as part of the developer role in each new feature branch.

[avallecam]

update the role of maintainer with

• how to process when package has breaking updates
• update stage of lesson in the life cycle
  • now in add communication callouts about dev stages or life cycle of tutorials to learners #64

[avallecam]

closing given the relocation of issues to independent entries