docs: Add a section in the documentation displaying versions of the frameworks and extension use.

anitab-org / bridge-in-tech-backend

BridgeInTech (BIT) is an application that allows organizations, mentors and mentees to actively collaborate through mentoring programs. This is the backend client of BridgeInTech.

https://bridgeintech-bit-heroku-psql.herokuapp.com/

GNU General Public License v3.0

24 stars 80 forks source link

docs: Add a section in the documentation displaying versions of the frameworks and extension use. #223

Open Amulya-coder opened 3 years ago

Amulya-coder commented 3 years ago

Description

In the readme add a section that shows the framework version and extensions used in the project.

Acceptance Criteria

Add the versions and extensions used in bridge-in-tech

Update [Required]

[ ] Currently used versions, extensions should be added

Definition of Done

[ ] All of the required items are completed.
[ ] Approval by 1 mentor.

welcome[bot] commented 3 years ago

Hello there!👋 Welcome to the project!💖

Thank you and congrats🎉for opening your very first issue in this project. AnitaB.org is an inclusive community, committed to creating a safe and positive environment.🌸 Please adhere to our Code of Conduct.🙌 You may submit a PR if you like! If you want to report a bug🐞 please follow our Issue Template. Also make sure you include steps to reproduce it and be patient while we get back to you.😄

Feel free to join us on AnitaB.org Open Source Zulip Community.💖 We have different streams for each active repository for discussions.✨ Hope you have a great time there!😄

Amulya-coder commented 3 years ago

@mtreacy002 I think this is a valid issue for first timers only can you please verify.

mtreacy002 commented 3 years ago

@Amulya-coder , can you please explain which specific framework and extension you want the contributors to add here? Do you mean the dependencies we use in the requirements.txt? If so, do we still need to state them on the Readme when contributors can see them from the requirements.txt?

Amulya-coder commented 3 years ago

Yes, @mtreacy002 the flask extensions and framework that are mentioned in the requirements.txt and this helps the new contributors to learn more about the project work if we defining the extensions, framework, Language used for developing the project in the readme so that it is easily noticed by the contributors.

Rahulm2310 commented 3 years ago

@Amulya-coder Thanks for opening this but I agree here with @mtreacy002. Also, github UI shows the languages used in the project.

Furthermore, we also have tags for project frameworks and languages in the about section.

So, I don't think there is need for adding redundant details again to the readme.

Amulya-coder commented 3 years ago

@Rahulm2310 Ahh... I know that there are default tags provided in the Github but it's a "good practice" to add it in the documentation also. This is used in the mentorship Backened too you can check :) .

matsy commented 1 year ago

@mtreacy002 Is this issue open? Is someone working on this?