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

Update Project Structure.md and Tutorial.md #174

Open
yashasvini121 opened this issue Oct 22, 2024 · 2 comments
Open

Update Project Structure.md and Tutorial.md #174

yashasvini121 opened this issue Oct 22, 2024 · 2 comments

Comments

@yashasvini121
Copy link
Owner

🌟 Problem:

  1. The project-structure.md file doesn't include descriptions for new files added to the project, such as dev-requirements and docker-compose.
  2. Contributors do not update the requirements.txt file properly.

💡 Expected Solution:

  1. 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.
  2. Update project-structure.md by including descriptions for the missing files.

Approach:

  1. Fork the repo
  2. Create a new branch and name it like fix-docs
  3. 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>
  4. Commit the changes
  5. 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.
@yashasvini121
Copy link
Owner Author

Hey @Xblade9669, let me know if you'd like to work on this issue. Feel free to reach out if you have any questions or need any clarification.

@prachi-0319
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

No branches or pull requests

2 participants