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

Add CONTRIBUTING.md document ** Copilot generated for experimenting ** #251

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

Conversation

adam4813
Copy link
Member

@adam4813 adam4813 commented 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.

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).
@adam4813 adam4813 changed the title Add CONTRIBUTING.md document ** Copilot generated for testing ** Add CONTRIBUTING.md document ** Copilot generated for experimenting ** Nov 12, 2024
Copy link

codecov bot commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 10.86%. Comparing base (27bf5da) to head (6246c2d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #251   +/-   ##
=======================================
  Coverage   10.86%   10.86%           
=======================================
  Files         110      110           
  Lines       13348    13348           
=======================================
  Hits         1450     1450           
  Misses      11898    11898           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

Create CONTRIBUTING doc
1 participant