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 a structural overview, build, release and contribution documentation #42

Open
3 tasks
archblob opened this issue Jan 14, 2021 · 0 comments
Open
3 tasks
Labels
documentation Improvements or additions to documentation

Comments

@archblob
Copy link
Member

archblob commented Jan 14, 2021

Documentation is missing right now and writing would ease future developments and decrease the barrier for new contributors.

  • We need an overview of how the code is structured, how we use our custom components and what we look for in general when implementing new features.
  • The build and release processes need documenting also.
  • It would be nice to also have a section with contributing guidelines.

The place for this would be the Readme.

@archblob archblob added the documentation Improvements or additions to documentation label Jan 14, 2021
@archblob archblob pinned this issue Apr 24, 2021
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