Well defined developer workflow

[mbtamuli]

Scope

• Have a docs/developer.md detailing the workflow for a developer
  • Initial setup
  • Development
  • Testing
  • Anything else expected by the project

Split from #93

[mbtamuli]

@mugdha-adhav Can I be assigned to this issue. I'd like to work on this.

[mbtamuli]

People working on developing this project - if you have any ideas/suggestions, please add a comment. I see @kitt1987, @MaxFedotov, @mugdha-adhav and @vadasambar contributing to the last 4 releases.

[vadasambar]

I don't have a specific suggestion but it would be nice to have a developer quickstart guide and contribution guide (PR naming convention, commit conventions to follow etc.,). Maybe a checklist of things might be a good idea. For example:

1. Pre-requisite reading (links to CSI docs etc.,)
2. Build pre-requisites (installing specific golang version, any other tools needed e.g., kustomize, kubectl etc.,)
3. Building binaries and images (also pushing images)
4. Developer workflow (e.g., creating a kind cluster and testing changes -> fix issues -> repeat)
5. Running unit tests
6. Running integration tests locally (these tests are also run in CI/CD pipeline)
7. Creating PR (we can link PR naming conventions, commit conventions, release chores like updating helm chart version, version in the makefile, writing unit and integration tests etc., can go here)

[mbtamuli]

#108 even if this PR doesn't directly work on the points mentioned in this issue, it's a step in the same direction. As getting that PR merged will ensure contributors can directly use the GitHub Container Registry image built by the CI and not have to build an image locally.

[mugdha-adhav]

Dependabot created automated PR for upgrading GitHub workflows version after #108 was merged 🎉

cc: @mbtamuli IMO we should document this as well ^^

[mugdha-adhav]

@mbtamuli in the community meeting we discussed about adopting conventional commits. I propose we add a note for the same in developer workflow.

[mugdha-adhav]

@mbtamuli I faced access denied issue while trying to push image to ghcr in my fork. Followed the answer in this discussion and got it working, we should definitely add this in the docs as well.

[mbtamuli]

Maybe it's related to a user using GHCR first time ever, or maybe the first time for that particular repository(your fork). Will check GitHub docs and update dev docs.

[mbtamuli]

I created a new fork for testing. This is the message shown on the actions page of the fork the first time.

We should probably add this to the docs too in some form.