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

Update contributing guide #20

Merged
merged 4 commits into from
Oct 1, 2024
Merged

Update contributing guide #20

merged 4 commits into from
Oct 1, 2024

Conversation

erinecon
Copy link
Contributor

Overview

Update CONTRIBUTING.md and add a template "How to contribute" page to point to CONTRIBUTING.md.
Also, small changes to the placeholder variables in the index.md page.

Rationale

Information for contributors is currently handled in two places for IS charms: Within the CONTRIBUTING.md file on GitHub and in a "How to contribute" page on Charmhub. While it's useful to have information in both places, it doesn't make sense to duplicate the information.

Proposed changes:

  • Moved some of the "How to contribute" material into the CONTRIBUTING.md file so the information is condensed.
  • Added placeholder variables for the charm name into the files.
  • Added a template page "How to contribute" that points to the CONTRIBUTING.md file.

Also in this PR: Changes to index.md proposed in a previous PR.

Juju Events Changes

None

Module Changes

None

Library Changes

None

Checklist

Template page for docs that will just point to the GitHub contributing guide.
Add information from the "How to contribute" pages included for IS charms
Add dummy variables for the charm name
Delete whitespaces in the temp variables
@erinecon erinecon added documentation Improvements or additions to documentation trivial labels Sep 26, 2024
@erinecon erinecon requested a review from a team as a code owner September 26, 2024 13:39
Copy link

Test coverage for 1a86d74

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py      31      0      4      0   100%
----------------------------------------------------------
TOTAL             31      0      4      0   100%

Static code analysis report

Run started:2024-09-26 13:42:14.188101

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 151
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

@erinecon erinecon merged commit c7db84e into main Oct 1, 2024
16 checks passed
@erinecon erinecon deleted the contributing-guide-changes branch October 1, 2024 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation trivial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants