You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Solution: restructure the installation guide and make it more usable
The Installation Guide for Developers needs to be updated and improved.
First of all it is not only an installation guide which is misleading. It is actually a guide to interact with github.
The guide can be merged with Installing from the Source Code.
The guide needs to have a new name and needs to be restructured. It's fine to explain the whole process to get the repository and how to commit+push it when changes were made. But additional to that we need to show how to set up the dev environment properly.
To Do:
Don't link to Advanced Installation Options just move it to the section (this should not just be advanced, but also the guide for devs, but only for installation(!)
Instead of cloning we should tell developers to fork, linking to the GitHub forking example should be good enough
Remove all steps after a successful installation and link to the Contributing section instead
Solution: restructure the installation guide and make it more usable
The Installation Guide for Developers needs to be updated and improved.
First of all it is not only an installation guide which is misleading. It is actually a guide to interact with github.
The guide can be merged with Installing from the Source Code.
The guide needs to have a new name and needs to be restructured. It's fine to explain the whole process to get the repository and how to commit+push it when changes were made. But additional to that we need to show how to set up the dev environment properly.
To Do:
Advanced Installation Options
just move it to the section (this should not just be advanced, but also the guide for devs, but only for installation(!)pre-commit
setup after the installation of the dependencies exampleOpen for comments/discussion/better ideas
The text was updated successfully, but these errors were encountered: