Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 3.3 KB
Raw

Contributing to TalkforgeAI

We welcome contributions from the community and are pleased to have you join us. This document is intended to guide you through the contribution process.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How to Contribute

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for TalkforgeAI, including completely new features and minor improvements to existing functionality:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of TalkforgeAI which the suggestion is related to.

Your First Code Contribution

Unsure where to begin contributing to TalkforgeAI? You can start by looking through the beginner and help-wanted issues:

  • Good first issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than Good first issues.

Pull Requests

  • Fill in the required template.
  • Do not include issue numbers in the PR title.
  • Follow the styleguides.
  • After you submit your pull request, verify that all status checks are passing.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Code Style

  • Use spaces for indentation rather than tabs.
  • (TODO) Follow the coding style guide of the project.

Documentation Style

  • Use Markdown to write documentation.
  • When adding new features, include corresponding documentation updates.

Additional Notes

  • If you're unable to complete your work on a pull request, consider marking it as a "Draft" until it's ready for review.

Thank you for contributing to TalkforgeAI!