Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.74 KB

Contributing to BriefOps Slack Summarisation App

Thank you for considering contributing to BriefOps Slack Summarisation App! We welcome contributions of all kinds, including code improvements, documentation updates, bug reports, feature requests, and more. This guide outlines the best practices for contributing effectively to this project.

How to Contribute

1. Reporting Issues

If you encounter any bugs, performance issues, or have suggestions for enhancements, please submit an issue:

  • Search Existing Issues: Before opening a new issue, please check the existing issues to avoid duplicates.
  • Create a New Issue: Use the Issues Template and provide detailed information, including:
    • Steps to reproduce (for bugs)
    • Expected and actual results
    • Screenshots or logs, if applicable
    • Environment details (e.g., OS, browser, or relevant software versions)

2. Proposing Features

We are always open to new ideas! If you want to propose a new feature:

  • Open a Discussion: Start a conversation in the Discussions tab to get feedback from the community and maintainers.
  • Submit a Feature Request: Create an issue with the label enhancement and detail your proposed feature, including:
    • The problem it solves
    • How it fits with the project's vision
    • Possible implementation details

3. Code Contributions

Contributing code involves a few key steps:

Fork and Clone the Repository

  1. Fork the repository to your GitHub account.
  2. Clone your fork to your local machine: 
    git clone https://github.com/jpantsjoha/briefops-public.git
cd briefops-public