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

Add documentation on how to tun the app locally and how to contribute #15

Open
panvicka opened this issue Jul 30, 2023 · 0 comments
Open
Assignees
Labels
technical dept The legacy of shortcuts taken by a clever but lazy dev
Milestone

Comments

@panvicka
Copy link
Owner

panvicka commented Jul 30, 2023

User Story

As a developer or contributor to the project, I want to have clear and comprehensive documentation available so that I can easily run the application locally and contribute effectively to its development.

Acceptance Criteria

  • The documentation should provide step-by-step instructions on how to set up the development environment and run the app locally.
  • The documentation should cover different operating systems (e.g., Windows, macOS, Linux) to cater to a diverse range of developers.
  • It should provide guidelines on coding standards, project structure, and best practices for contributing to the codebase.
  • The documentation should include information on the version control system used (e.g., Git) and how to work with branches and pull requests.
  • Steps for running automated tests, if applicable, should be part of the documentation.
  • The documentation should be written in a clear and understandable language, with examples and illustrations where necessary.
@panvicka panvicka self-assigned this Jul 30, 2023
@panvicka panvicka converted this from a draft issue Jul 30, 2023
@panvicka panvicka added this to the till October milestone Jul 30, 2023
@panvicka panvicka added the technical dept The legacy of shortcuts taken by a clever but lazy dev label Jul 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical dept The legacy of shortcuts taken by a clever but lazy dev
Projects
Status: Todo
Development

No branches or pull requests

1 participant