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.

Sign up for GitHub

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

Jump to bottom

docs: Expand CONTRIBUTING docs #583

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Expand CONTRIBUTING docs #583

wants to merge 1 commit into from

Conversation

DanielArndt
Copy link
Member

Add details on

  • Library structure
  • Running integration tests locally

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that validate the behaviour of the software
  • I validated that new and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have bumped the version of any required library.

@DanielArndt
docs: Expand CONTRIBUTING docs
ae04728 
Add details on

- Library structure
- Running integration tests locally
@DanielArndt DanielArndt force-pushed the update-contributing-guide branch from 2ca1b8d to ae04728 Compare January 10, 2025 22:50
@DanielArndt
Copy link
Member Author

@saltiyazan Can you take a peak and see if this is correct?

saltiyazan
saltiyazan approved these changes Jan 13, 2025
View reviewed changes
Copy link
Contributor

@saltiyazan saltiyazan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good, however I probably would avoid listing all libraries while making sure it is clear that some of the libraries owned by this charm are only for internal use of the Vault charms.

@DanielArndt
Copy link
Member Author

It looks good, however I probably would avoid listing all libraries while making sure it is clear that some of the libraries owned by this charm are only for internal use of the Vault charms.

I agree. I struggled with this a bit. I need to find a better approach, I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@saltiyazan saltiyazan saltiyazan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@DanielArndt @saltiyazan