Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dev specific doc for CloudHarness CLI tools #711

Merged
merged 2 commits into from
Jan 29, 2024
Merged

Conversation

aranega
Copy link
Member

@aranega aranega commented Oct 30, 2023

This PR proposes a documentation for CloudHarness developers, to help to locate and understand how the different part of the projects are working together.

The CloudHarness code base can be really complicated to understand well in the first place, there is a lot of sub-projects and libraries. This documentation aims developers to help them navigate through the source code and understand some concepts in order to be able to fix bugs or extend the various tools present in CloudHarness to implement new features quickly.

Sanity checks:

  • The pull request is explicitly linked to the relevant issue(s)
  • The issue is well described: clearly states the problem and the general proposed solution(s)
  • From the issue and the current PR it is explicitly stated how to test the current change
  • The labels in the issue set the scope and the type of issue (bug, feature, etc.)
  • All the automated test checks are passing
  • All the linked issues are included in one milestone
  • All the linked issues are in the Review/QA column of the board
  • All the linked issues are assigned

Breaking changes (select one):

  • The present changes do not change the preexisting api in any way
  • This PR and the issue are tagged as a breaking-change

Possible deployment updates issues (select one):

  • There is no reason why deployments based on CloudHarness may break after the current update
  • This PR and the issue are tagged as alert:deployment

Test coverage (select one):

  • Tests for the relevant cases are included in this pr
  • The changes included in this pr are out of the current test coverage scope

Documentation (select one):

  • The documentation has been updated to match the current changes
  • The changes included in this PR are out of the current documentation scope

Nice to have (if relevant):

  • Screenshots of the changes
  • Explanatory video/animated gif

@filippomc
Copy link
Collaborator

Hey @aranega I see this is still in draft, worth merging in your opinion?

@aranega
Copy link
Member Author

aranega commented Jan 15, 2024

@filippomc I think it's OK, but you should take a look to see if I'm not saying something wrong inside. I don't think it's finished yet, but at the same time, it's something that we can improve with time.

@filippomc filippomc marked this pull request as ready for review January 29, 2024 11:46
@filippomc filippomc merged commit fe96676 into develop Jan 29, 2024
5 checks passed
@filippomc filippomc deleted the feature/dev-doc branch January 29, 2024 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants