Contributors to the project don't know how to contribute

[mariha]

Obviously we need contributors guidelines that would answer most questions that a new comer to the project may have.

We plan to use ZeroMQ C4 process as a starting point.

For more info, refer to How to structure collaboration on the project? trello card until we move the card to github. There happened to be also this discussion https://github.com/FediHospEx/fedihospex.github.io/discussions/10

• [ ] create contributor's guidelines
• [x] point to C4 as for what?
• [ ] clarify how?
• [ ] include DoD
• [ ] what about contributors guidelines from trustroots? don't confuse people

How: state issues in github as problems, PRs are potential solutions.

[mariha]

Definition of Done

• code changes are made and locally tested (almost done)
• changes (new functionalities, bug fixes) are guarded by automated tests and integrated with the codebase (code is done)
  • This step involves opening and merging a PR.
• code is deployed to all users (done)
• everything that would be good for the outside world to get to know about is communicated (done, done!)
• everything that may be useful for anyone in the future is written down (done, done, done.)

[mariha]

Tips, tricks and tools for the development flow:

How can I easily see the changes?

• without opening ide, in the browser
  • should we auto-deploy each PR somewhere?

• in my IDE, to play with the code note that PRs are not a branches but forked repos

  • you can use the github CLI to checkout a pr, even if it's from a forked repo, e.g. gh pr checkout 234 https://cli.github.com/manual/gh_pr_checkout

  • since it is not a branch, can not fetch and switch, need to update upstream in your pre-existing repo might be preferred for long term contributors or in general if you prefer to work on one repo

    https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes

    # check remote repos
    git remote
    git remote -v
    
    # adding remote repo
    git remote add <remote alias> <url>
    
    git fetch <remote alias>
    git pull --rebase <remote alias>
    git push <remote alias> <branch>
    
    git remote remove <remote alias>

[weex]

I saw there's a (todo) on the front page of the website. That could be replaced with this simple line from the 0MQ readme.

This project uses C4(Collective Code Construction Contract) process for contributions.