Skip to content

Latest commit

 

History

History
90 lines (67 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

90 lines (67 loc) · 2.94 KB

Contributing to Bulldog

Thank you for your interest in contributing to Bulldog! This document provides guidelines and instructions for contributing to the project.

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it before contributing to the project.

Issues

Please report issues on the issue tracker.

If you find a bug or a potential issue:

  • Check the Issues to see if it has already been reported.
  • If it has not been reported, create a new issue.
  • Please provide:
    • A clear and descriptive title
    • A detailed description of the problem
    • A code snippet reproducing the issue
  • Environment details (OS, .NET version, etc.)
  • Any other relevant information

Pull Requests

Please create a pull request on the pull request tracker. Follow the guidelines below:

  1. Before Submitting

    • Fork the repository
    • Create a new branch for your changes
    • Update your branch with the latest changes from main
    • Run all tests
    • Ensure code follows style guidelines
    • Update documentation as needed

  2. Pull Request Guidelines

    • Use a clear and descriptive title
    • Provide a detailed description of changes
    • Reference related issues
    • Include screenshots for UI changes
    • Request reviews from appropriate team members

  3. Review Process

    • Address all review comments
    • Make requested changes
    • Keep the PR focused and manageable
    • Respond to feedback promptly

Code Quality Standards

  • Write clean, readable, and maintainable code
  • Follow the project's coding style and conventions
  • Include appropriate comments and documentation
  • Ensure code is properly formatted
  • Remove any debug code or console logs before submitting

Testing Requirements

  • Write unit tests for new features
  • Ensure all tests pass before submitting
  • Include integration tests when applicable
  • Maintain or improve test coverage
  • Run all tests before submitting
  • Run dotnet format to ensure code is properly formatted

Community Involvement

We welcome all forms of community participation! Here's how you can get involved:

Join discussions in GitHub Issues and Pull Requests Help review pull requests from other contributors Improve documentation

  • Share your experience using Tack
  • Help answer questions from other users
  • Participate in feature planning and design discussions

License

This project is licensed under the Apache 2.0 License. By contributing to Bulldog, you agree that your contributions will be licensed under the same license.

Thank you for contributing to Bulldog!