Closed AfubeAngel closed 1 month ago
@AfubeAngel is attempting to deploy a commit to the manuelalferez's projects Team on Vercel.
A member of the Team first needs to authorize it.
@manuelalferez Please assist with the authorization for the deployment. I updated the CONTRIBUTING.md as directed and included the changes you made in the README.md
The latest updates on your projects. Learn more about Vercel for Git ↗︎
Name | Status | Preview | Comments | Updated (UTC) |
---|---|---|---|---|
flowinance | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Oct 16, 2024 9:16am |
@AfubeAngel Sorry, but I don't see any improvement in the documentation. A lot of text has been added, no changes have been made that would help users understand the project better. More than 250 lines were added. Too many.
If you want to improve the documentation, please describe what can be improved from the existing one and what can be improved.
The new text you have written has been copied and pasted on top of what was already there:
https://github.com/user-attachments/assets/6454cd95-fb84-4959-93be-3ab5af502372
@manuelalferez Is it alright with you if I close this pull request and open a new one considering all the corrections? As you mentioned, the README.md is fine. So I added the table of contents for faster navigation and updated the prerequisites to take supabase into account. I apologize for the duplication. The primary changes were done in the CONTRIBUTING.md which I had to write with fresh contributors or beginners in mind but since it is too long; I would shorten it according to your directions.
Or should I go ahead and make the changes on this pull request? Thank you
@AfubeAngel It is better to keep everything in the same PR, this way the whole history of the improvement is kept in a single point and not in multiple places. But as it is easier for you, if you see that it is going to be too much, open a new one 😊
@manuelalferez I'll just push on this PR.
Please is this shorter version acceptable for the contributing.md?
@AfubeAngel The guideline is already an explanation of how to contribute, the how to contribute only explains how to install the project: that information is already in the README. maybe you can change it to something like: Installation, “Follow the instructions in the readme to install and run the project” and add a link
@AfubeAngel great job!! Much better. Ready to merge
Pull Request Template
What
Updated the README.md and CONTRIBUTING.md files to enhance clarity and guidance for new contributors.
How
Revised sections for installation and contribution guidelines to improve usability and understanding. Added detailed instructions on setting up the development environment and contributing effectively.
Additional Notes
These updates aim to streamline the onboarding process for new contributors and improve overall project documentation.
issue #94