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

Missing STYLEGUIDE.md #292

Closed
1 task
Krieke opened this issue Apr 24, 2023 · 1 comment
Closed
1 task

Missing STYLEGUIDE.md #292

Krieke opened this issue Apr 24, 2023 · 1 comment
Assignees
Labels
kind/bug Something isn't working. The software does not behave as expected or specified.

Comments

@Krieke
Copy link
Contributor

Krieke commented Apr 24, 2023

Bug Report

Description

The CONTRIBUTING.md section Adhere to Coding Style Guide has a link with name styleguide with a destination anchor to a STYLEGUIDE.md source that doesn't exist in the project.

The CONTRIBUTING.md contains more references to this STYLEGUIDE.md

Expected Behaviour

That the styleguide source anchor would have an existing destination anchor source STYLEGUIDE.md or that this section is being removed from the document.

Observed Behaviour

Broken link due to missing source for the configured the destination anchor.

Steps to Reproduce

Steps to reproduce the behaviour:

  1. Open 'CONTRIBUTING.md'
  2. Go to '###adhere-to-coding-style-guide'
  3. Click on 'styleguide'
  4. See error 404 not found

Context Information

main branch during issue creation

Possible Implementation and Work Breakdown

  • Add a STYLEGUIDE.md in the root of the project containing the expected coding style details for this project.
@Krieke Krieke added the kind/bug Something isn't working. The software does not behave as expected or specified. label Apr 24, 2023
@SebastianOpriel
Copy link
Member

Please have a look here and maybe copy the missing file: https://github.com/sovity/github-repo-template

ununhexium pushed a commit that referenced this issue May 2, 2024
Updated some of the sections to make it more suitable for MDS audience to post their feature requests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Something isn't working. The software does not behave as expected or specified.
Projects
None yet
Development

No branches or pull requests

3 participants