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: refactor contributing guide - linter requirements #1412

Merged
merged 7 commits into from
Jun 12, 2023
Merged

docs: refactor contributing guide - linter requirements #1412

merged 7 commits into from
Jun 12, 2023

Conversation

YashPimple
Copy link
Member

@YashPimple YashPimple commented May 14, 2023 •
edited
Loading

Relate #972
Fix #999

Resolved the markdown-lint issue

Signed-off-by: Yash Pimple [email protected]

@YashPimple YashPimple requested review from a team as code owners May 14, 2023 07:57
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 14, 2023
@netlify
Copy link

netlify bot commented May 14, 2023 •
edited
Loading

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 3ffadb3
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/64870fe03fe24100083ee90b
😎 Deploy Preview https://deploy-preview-1412--keptn-lifecycle-toolkit.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

agardnerIT
agardnerIT previously approved these changes May 14, 2023
View reviewed changes
@agardnerIT
Copy link
Contributor

Does this replace #1387? If so, please close #1387.

Please refer to the documentation for further details. - I think that text is irrelevant as I am reading the documentation.

This project uses a set of linters to ensure good code quality. In order to make proper use of those linters inside an IDE, the following configuration is required. - I just know that markdownlint is going to moan about two sentences on one line. Just put line breaks between them to keep the tool happy.

Other than that, great job and a nice small PR (easy to review so that's great). LGTM.

@YashPimple
Copy link
Member Author

Hi @agardnerIT,
I have updated the documentation and added the necessary line breaks. Do have a look

StackScribe
StackScribe previously approved these changes Jun 1, 2023
View reviewed changes
StackScribe
StackScribe previously approved these changes Jun 8, 2023
View reviewed changes
@mowies
fix PR comments
c06af3e 
Signed-off-by: Moritz Wiesinger <[email protected]>
mowies
mowies previously approved these changes Jun 12, 2023
View reviewed changes
@mowies
fix markdown
20ca870 
Signed-off-by: Moritz Wiesinger <[email protected]>
@mowies mowies changed the title docs: update docs linters-requirements section docs: refactor contributing guide Jun 12, 2023
@mowies mowies changed the title docs: refactor contributing guide docs: refactor contributing guide - linter requirements Jun 12, 2023
@sonarcloud
Copy link

sonarcloud bot commented Jun 12, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@StackScribe StackScribe merged commit 2ccdec7 into keptn:main Jun 12, 2023
@keptn-bot keptn-bot mentioned this pull request Jun 12, 2023
Merged
StackScribe added a commit to StackScribe/lifecycle-toolkit that referenced this pull request Jun 19, 2023
@YashPimple @StackScribe @mowies
docs: refactor contributing guide - linter requirements (keptn#1412)
8445325 
Signed-off-by: Yash Pimple <[email protected]>
Signed-off-by: Yash Pimple <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
Co-authored-by: Meg McRoberts <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
StackScribe added a commit to StackScribe/lifecycle-toolkit that referenced this pull request Jun 22, 2023
@YashPimple @StackScribe @mowies
docs: refactor contributing guide - linter requirements (keptn#1412)
7e77a29 
Signed-off-by: Yash Pimple <[email protected]>
Signed-off-by: Yash Pimple <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
Co-authored-by: Meg McRoberts <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
@keptn-bot keptn-bot mentioned this pull request Jun 26, 2023
Merged
@YashPimple YashPimple mentioned this pull request Jun 28, 2023
Closed
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aepfli aepfli aepfli left review comments

@mowies mowies mowies approved these changes

@StackScribe StackScribe StackScribe approved these changes

@agardnerIT agardnerIT agardnerIT left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Contrib: linters requirements
5 participants
@YashPimple @agardnerIT @StackScribe @mowies @aepfli