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

M2: Improve contributing guidelines #1

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

ninetteadhikari
Copy link
Member

@ninetteadhikari ninetteadhikari commented Jul 2, 2024

Objective
Develop a comprehensive “How to contribute to cabotage-app” guide, filling the existing gap in project documentation.

Deliverables:

  • Create a Pull Request Template and an Issue Template that includes guidelines on how to contribute.
  • Improve README:
    • Friendly introduction
    • If the project is interested in a Code Of Conduct, reference it
    • Reference contribution guidelines
  • Create a Contributing doc: How to contribute to this open source project (how to make a PR, etc);
  • Contributor expectation management:
    • What to do after I open a PR?
    • Do I need to notify anyone?
    • How long does it take to get a review?

@ninetteadhikari ninetteadhikari changed the title Update issue templates M2: Improve contributing guidelines Jul 2, 2024
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link

@hulkoba hulkoba left a comment

Choose a reason for hiding this comment

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

LGTM

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.

3 participants