Create CONTRIBUTING doc #149
Assignees
Labels
build-process
issues relating to the build, development or release processes
Milestone
Comments
adam4813
added
the
build-process
adam4813
added
stale
adam4813
added a commit
that referenced
this issue
Nov 12, 2024
Fixes #149 Add a `CONTRIBUTING.md` file to the repository. * **Flow for Contributing**: Describe the steps for contributing, including forking the repository, creating a new branch, making changes, submitting a PR, and rebasing to master and merging. * **Patterns to Use**: Specify the use of lock guards instead of manual lock/unlock blocks and reference the Coding Patterns page in the wiki. * **What Makes a Good Issue**: Provide guidelines on writing clear and concise issue descriptions, steps to reproduce, expected behavior, and additional context. * **Release Schedule**: Include information on the project's release schedule. * **Additional Resources**: Add a link to the wiki for more detailed information and guidelines. * **Coding Standards**: Include links to the coding standards in the wiki for comments, file structure, indentation and bracing, and naming. * **Checklist for Submitting a PR**: Provide a clear and concise checklist for contributors to follow when submitting a PR. * **Labels for Issues**: Suggest using labels like "good first issue" and "help wanted" for issues. * **Guidelines for Writing Good Issues and Pull Requests**: Offer detailed guidelines for writing good issues and pull requests, including examples and common mistakes to avoid. * **Writing Effective Commit Messages**: Include a section on how to write effective commit messages, with examples and best practices. * **Running Tests Locally**: Provide instructions on how to run tests locally before submitting a PR. * **Automating the Contribution Process**: Suggest automating parts of the contribution process using GitHub Actions or other CI/CD tools. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/trillek-team/tec/issues/149?shareId=XXXX-XXXX-XXXX-XXXX).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This could cover the flow for contributing e.g
fork -> PR -> rebase to master and merge, patterns we won't to see used such as lock guard vs manual lock/unlock blocks, what makes a good issue, and release schedule.The text was updated successfully, but these errors were encountered: