search

vania-dart / framework

Fast, simple, and powerful backend framework for Dart built with ❤️
https://vdart.dev
MIT License
155 stars 12 forks source link

[Documentation] - Improve Contribution Guidelines #74

Open hptavakoli opened 1 month ago

hptavakoli commented 1 month ago

Description

We need to improve the Contribution Guidelines to include the latest version of the Code of Conduct and to reflect the roles and responsibilities of the community leaders.

Location

This will be added/updated in the CONTRIBUTING.md file in the root directory of the repository.

Type of Issue

Suggested Resolution

Enhance the CONTRIBUTING.md file with the following improvements:

  1. Update the Table of Contents.
  2. Include a section on the Code of Conduct with a link to CODE_OF_CONDUCT.md.
  3. Outline the process for reporting bugs, proposing features, and submitting pull requests.
  4. Add details on setting up the development environment.
  5. Provide an overview of the repository structure.
  6. Describe the process for releasing new versions.
  7. List community support channels.
  8. Define the enforcement responsibilities and roles of the community leaders:
    • Lead Maintainer: Javad, [javad@example.com]
    • Co-Maintainer and Mobile Compatibility Manager: Ali, [ali@example.com]
    • Community and Project Manager: Hossein, [hossein@example.com]
  9. Provide contact information for reporting Code of Conduct violations: coc@vdart.dev or via the contact form at vdart.dev/contact.

Additional Context

This improvement will help streamline the contribution process and ensure that contributors are aware of the Code of Conduct and the roles of the community leaders. It will also provide clear guidelines for setting up the development environment and managing the repository.

Would you like to work on this issue?