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
The project-structure.md file doesn't include descriptions for new files added to the project, such as dev-requirements and docker-compose.
Contributors do not update the requirements.txt file properly.
💡 Expected Solution:
Add a step in tutorial.md instructing contributors to update the requirements.txt file when necessary and test the entire project to ensure there are no version conflicts between packages.
Update project-structure.md by including descriptions for the missing files.
Approach:
Fork the repo
Create a new branch and name it like fix-docs
Clone the repo locally, or you can even change the files on github.dev, for this, change your repo url from github.com/<username>/<repo> to github.dev/<username>/<repo>
Commit the changes
Make a pr for it and link this issue
Note:
Prefer using a new branch to resolve the issue, as it helps keep the main branch stable and makes it easier to manage and review your changes.
Strictly use the pull request template provided in the repository to create a pull request.
The text was updated successfully, but these errors were encountered:
Hey, I would like to take up this open issue!
I have prior experience in technical documentation and structuring the projects. I can make a valuable contribution to this project and make sure the Project Structure.md and Tutorial.md give clear instructions for the contributors.
🌟 Problem:
project-structure.md
file doesn't include descriptions for new files added to the project, such asdev-requirements
anddocker-compose
.requirements.txt
file properly.💡 Expected Solution:
tutorial.md
instructing contributors to update therequirements.txt
file when necessary and test the entire project to ensure there are no version conflicts between packages.project-structure.md
by including descriptions for the missing files.Approach:
fix-docs
github.com/<username>/<repo>
togithub.dev/<username>/<repo>
Note:
The text was updated successfully, but these errors were encountered: