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

#13 - Add a CONTRIBUTING.md #15

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JoaquimCJunior
Copy link

We need a CONTRIBUTING.md template for our repository. The goal of this file is to guide contributors on how to contribute to the "Good First Issues" project. It should contain the following sections:

  • A thank you note for contributing

  • Table of contents

  • How to contribute, including instructions for:

    • Reporting bugs
    • Submitting code
    • Contributing to documentation
    • Adding new features
  • Getting started, including instructions on how to fork and clone the repository

  • Project workflow

  • How to add repositories and issues with the "Good First Issue" label

  • Code of conduct

  • Steps for Implementation:

  • Create the basic structure for the CONTRIBUTING.md file.

  • Include a table of contents with links to each section.

  • Write detailed instructions for each type of contribution.

  • Provide a practical example of how to fork and clone the repository.

  • Add a section about the project workflow.

  • Explain how to add new repositories and issues with the "Good First Issue" label.

-Risks and Challenges:

  • Ensuring the instructions are clear and easy to understand, especially for beginners on GitHub.
  • Keeping the file concise without losing clarity.

Copy link
Contributor

@vsoch vsoch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you use an LLM to generate this?

- add-repos.py: Adds repositories to .github/repos.txt.
- generate-first-issues.py: Generates and updates issues labeled "Good First Issue" based on the repositories listed.

To run the scripts locally:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might want to advise here to run this in a throwaway clone or branch, because it will change the state of the repository (and we typically want the actual updates to come in the automation).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants