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

Refactor the Readme #46

Open
KjetilIN opened this issue Jul 14, 2023 · 0 comments
Open

Refactor the Readme #46

KjetilIN opened this issue Jul 14, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@KjetilIN
Copy link
Collaborator

KjetilIN commented Jul 14, 2023

Improvement for the readme are needed

The readme has to contain better information.

Suggestion list

  • The start of the current readme can stay the same. It looks good with the logo and the text that explains the code. Good.
  • Technology badges are cool, but I think a banner (image) with all the logos for all technologies could look good. It would be costume made for the repository and just to give a quick insight into what is used. A more detailed list should be a own markdown file or a section in the readme
  • Also a list of other markdowns that are relavent should be mentioned.
  • Add contact details to the IT team/Webdev team/ IT Leder
  • How to run the reposotory localy
  • (Feature toggle system)
  • How versioning is done -> realses
  • How to join the team
  • Who is repsonsible
  • How to mention bugs or suggest improvements
@KjetilIN KjetilIN added the documentation Improvements or additions to documentation label Jul 14, 2023
@KjetilIN KjetilIN self-assigned this Oct 13, 2023
@KjetilIN KjetilIN removed their assignment Feb 22, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant