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

Establish contribution guidelines for issue labeling, branch naming, and pull request conventions, and add to README #43

Open
mattfsourcecode opened this issue Jan 16, 2025 · 0 comments

Comments

@mattfsourcecode
Copy link
Owner

Example workflow:

  1. Issue Labels: Define a set of labels (e.g., bug, enhancement, documentation, help wanted) and their usage.
  2. Branch Naming: Specify branch naming conventions (e.g., enhancement/issue-<number>, bug/issue-<number>).
  3. Pull Requests:
    • Require descriptive titles summarizing the change.
    • Include a detailed description of changes, testing steps, and references to related issues.
    • Ensure pull requests link to relevant issues.
  4. Testing Expectations: Specify requirements for tests (unit, integration, etc.) to be included in the PR when applicable.
  5. Add an example workflow for contributors in the README (e.g., "Create an issue, start a branch, submit a PR").
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

No branches or pull requests

1 participant