open-ecommerce-api / store-engine

An ecommerce backend-API created using Django and DRF (Django Rest Framework).
GNU General Public License v3.0
13 stars 11 forks source link

Readme #72

Open zamaniamin opened 1 year ago

zamaniamin commented 1 year ago

Please share your collected knowledge and information in this section as a user story for front and back end users. And finally make the issues and do the workflow with the issue. Contact me if you need to talk.

aminm08 commented 1 year ago

Readme

As a software developer at open e-commerce, I want to create a well-structured and informative README file, so that users and contributors can easily understand the purpose, features, setup, and usage of this platform

User Story

As a user, I want to be able to see a brief and comprehensive introduction to the project explaining its purpose and key features so that I can know the project better

As a user, I want to have appropriate contact information, including email addresses, social media profiles, and the issue tracker so that I can contact the developers or admins and report issues.

As a user, I want to be able to see the technology stack and architecture of the project so that I can check if I have the required knowledge to contribute.

As a developer, I want to have a complete contribution guideline including project structure, coding standards, and the process for submitting pull requests and reporting issues so that I can contribute without any problem.

As a user, I want to find clear and concise instructions on how to install the project so that I can run the project in my local environment.

As a user, I want to find a section detailing the licensing terms and any copyright notices.

Issues

zamaniamin commented 1 year ago

also you can recheck this page for better readme. https://github.com/orgs/open-ecommerce-api/discussions/64