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

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

Open
3 tasks
Amulya-coder opened this issue Mar 23, 2021 · 7 comments
Labels
Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers. Status: Available Issue was approved and available to claim or abandoned for over 3 days.
Projects

Comments

@Amulya-coder
Copy link
Member

Amulya-coder commented Mar 23, 2021

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
Copy link

welcome bot commented Mar 23, 2021

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
Copy link
Member Author

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

@mtreacy002
Copy link
Member

mtreacy002 commented Mar 23, 2021

@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
Copy link
Member Author

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.

@Amulya-coder Amulya-coder changed the title Add a section in the documentation displaying versions of the frameworks and extension use. docs: Add a section in the documentation displaying versions of the frameworks and extension use. Mar 24, 2021
@Amulya-coder Amulya-coder added Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers. Open Source Hack Status: Available Issue was approved and available to claim or abandoned for over 3 days. labels Mar 24, 2021
@Rahulm2310
Copy link
Contributor

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

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

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

@Amulya-coder
Copy link
Member Author

Amulya-coder commented Mar 24, 2021

@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 :) .

@mtreacy002 mtreacy002 added this to In Progress in BIT Roadmap Apr 4, 2021
@mtreacy002 mtreacy002 moved this from In Progress to Icebox in BIT Roadmap Apr 4, 2021
@matsy
Copy link

matsy commented May 17, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation/Training Improvements or additions to documentation. First Timers Only Good for newcomers. Status: Available Issue was approved and available to claim or abandoned for over 3 days.
Projects
BIT Roadmap
New Issues
Development

No branches or pull requests

4 participants