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

Commits on Nov 12, 2024

  1. Add CONTRIBUTING.md document ** Copilot generated for testing **

    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 committed Nov 12, 2024
    Configuration menu
    Copy the full SHA
    6246c2d View commit details
    Browse the repository at this point in the history