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

Update the README.md #4

Closed
2 tasks
CoachBirgit opened this issue Aug 15, 2023 · 1 comment
Closed
2 tasks

Update the README.md #4

CoachBirgit opened this issue Aug 15, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@CoachBirgit
Copy link
Contributor

User Story or Initial Idea:
As a visitor or potential contributor to the #deib-working-group repository, I want a comprehensive overview of the project so that I can understand its purpose, goals, and how to get involved.

Issue Summary:
The repository requires a README.md file to provide essential information about the DEIB working group, its mission, and guidelines for participation.

Background & Context (The Why):
A README.md file serves as the first point of contact for anyone visiting the repository. It provides context, sets expectations, and guides visitors on how to engage with the project.

Acceptance Criteria:

  • A detailed README.md file is present in the repository.
  • The file provides an overview of the DEIB working group, its mission, goals, and contribution guidelines.

Proposed Steps or Tasks:

  1. Outline the key sections for the README.md file.
  2. Draft the content, providing details about the DEIB working group, its objectives, and how to contribute.
  3. Review and gather feedback from the team.
  4. Finalize and add the file to the repository.

Dependencies or Blockers:
None identified.

Additional Information:
Consider adding links to other important documents in the repository, such as the code_of_conduct.md and CONTRIBUTING.md files.

Related Issues or Links:
None.

@CoachBirgit CoachBirgit added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 15, 2023
@CoachBirgit
Copy link
Contributor Author

I copied the text, I've written on wp-deib.org as a starter for the README.md into a Google Doc.

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 good first issue Good for newcomers
Projects
Status: Done
Development

No branches or pull requests

1 participant