Contributors Guide for lifecycle-controller

hrittikhere commented 1 year ago

A contributor guide for incoming contributors will help them set up the codebase and test the contributions.

From @StackScribe

Source material to get you started:

Follow the Keptn setup for Go/Docket/K8s etc
- https://github.com/keptn/keptn/tree/master/docs/developer
https://github.com/keptn/lifecycle-toolkit#install-a-dev-build
https://github.com/keptn/lifecycle-toolkit/blob/main/CONTRIBUTING.md#contributing
https://github.com/keptn/lifecycle-toolkit/blob/main/operator/README.md

Amishakumari544 commented 1 year ago

Hi @thschue I woul like to work on this issue.

Amishakumari544 commented 1 year ago

sorry for being late working on this now

thisthat commented 1 year ago

Duplicated issue with some resources: https://github.com/keptn/lifecycle-toolkit/issues/696#issue-1556346094

rakshitgondwal commented 1 year ago

Hey! @thisthat @Amishakumari544 I would like to work on this too.

sudiptob2 commented 1 year ago

I am also interested in this issue and happy to collaborate with others who are working on this. I think we can connect and collaborate. I am available on Keptn Slack channels and on Linkedin

StackScribe commented 1 year ago

It looks like we have a great team to work on this! @rakshitgondwal , github isn't letting me make you an assignee for some reason but we'll keep working on it. We'll be looking forward to seeing what you come up with. My suggestion is that you agree on an initial high-level outline and do a PR that just sets that up. We'll merge that and then you can work on small pieces to fill in the content.

Amishakumari544 commented 1 year ago

@StackScribe I am working on this issue if anyone wants they can join me

StackScribe commented 1 year ago

Goal

A contributor guide for incoming contributors will help them prepare to contribute, set up the codebase, and test the contributions.

Problem

People who are contributing code, examples, and documentation to the KLT project need information beyond what users need. This information includes:

Knowledge about ancillary technologies and concepts
How to set up a development environment and a test environment
How to test the product at different levels (unit tests, integration tests, regressions, full system tests)
Specific information about how to implement different types of features for the product.

Issues to discuss:

Should this be called "Contributors Guide", "Developer Guide", or should we have both?
- This will be discussed as part of the larger discussion about the KLT doc structure. For now, we will develop this content as part of the CONTRIBUTING.md file in the lifecycle-toolkit CONTRIBUTING.md file
What is the relationship between information in this guide, information in the CONTRIBUTING.md file in each repo, and information on the Community pages?
How do we handle information that is common to Keptn V1 and KLT and possible OpenFeature? Do we just copy the content to the appropriate repos and maintain them in parallel or can we create common code somewhere that is sourced into each project?

Technical Details

Provisional outline:

Familiarize yourself with ancillary technologies
Understand devops and gitops
Working with github
Working with REST APIs
Understanding golang
Software testing theory
Setting up a development environment
Creating unit and integration tests for your code
Creating a metrics operator
...

DoD

### Tasks
- [ ] link to the ticket1
- [ ] https://github.com/keptn/lifecycle-toolkit/issues/733 (Kubernetes)
- [ ] https://github.com/keptn/community/issues/217 (github)
- [ ] https://github.com/keptn/lifecycle-toolkit/issues/791 (keptn/keptn CONTRIBUTING.md info)

sudiptob2 commented 1 year ago

Great, I would like to work on the Familiarize yourself with ancillary technologies reference material part to begin with. #733 has been created regarding this. :blush:

StackScribe commented 1 year ago

@sudiptob2 Fabulous! I think we should break this up into small pieces so you can do small PRs, which are much preferred -- they are easier to review and things just move more efficiently. I need to set up the basic structure for the devguide and then you should take what you have for the k8s stuff and create a PR for it. Then you can do another PR for, say, gitops and devops. I am working on turning this ticket into a proper epic -- we have not done those for doc work in the past but we want to do them moving forward. I have listed the topics I thought of in the "Provisional outline" section. As you create issues for each component part, I will add links to those tickets to the "Tasks" list and then I think we check them off as they are completed.

I'm still learning this system but I do think it is brilliant. It is, of course, intended to be flexible. If you get into it and decide, for example, that you want to separate pages for devops and gitops, that is just fine -- we'll adjust the epic to reflect that.

rakshitgondwal commented 1 year ago

Hey @StackScribe! I can work on

Understanding DevOps and Gitops.
Working with GitHub.
Understanding Golang

I will work on these, one by one, and create a PR for them separately.

sudiptob2 commented 1 year ago

@StackScribe could you please add #808 to the task list? Also, assign me the issue.

rakshitgondwal commented 1 year ago

@StackScribe I'll be working on documentation related to the setting up of a local dev environment. Please assign this to me #809.

rakshitgondwal commented 1 year ago

I guess we should have a status or something like that by which we would be able to track our progress in the issue.

keptn / lifecycle-toolkit