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

[Documentation] - Improve Contribution Guidelines #74

Open
2 of 6 tasks
hptavakoli opened this issue Jun 2, 2024 · 0 comments
Open
2 of 6 tasks

[Documentation] - Improve Contribution Guidelines #74

hptavakoli opened this issue Jun 2, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@hptavakoli
Copy link
Contributor

hptavakoli commented Jun 2, 2024

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

  • Typo
  • Inaccuracy
  • Enhancement
  • Other

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:
  9. Provide contact information for reporting Code of Conduct violations: [email protected] 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?

  • Yes
  • No
@hptavakoli hptavakoli added the feature request Proposals for new features label Jun 2, 2024
@hptavakoli hptavakoli added this to the 0.2.8 milestone Jun 2, 2024
@hptavakoli hptavakoli self-assigned this Jun 2, 2024
@hptavakoli hptavakoli moved this to Planned in Development Roadmap Jun 2, 2024
@hptavakoli hptavakoli added the enhancement New feature or request label Jun 2, 2024
@hptavakoli hptavakoli changed the title [Feature Request] - Improve Contributing Guideline [Documentation] - Improve Contribution Guidelines Jun 3, 2024
@hptavakoli hptavakoli added documentation Improvements or additions to documentation and removed feature request Proposals for new features labels Jun 3, 2024
@hptavakoli hptavakoli moved this from Planned to In Development in Development Roadmap Jun 3, 2024
@javad-zobeidi javad-zobeidi removed this from the 0.4.0 milestone Jul 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: In Development
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants