Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 2.82 KB
Raw

Contributing to CC Diary

First off, thank you for considering contributing to CC Diary! It's people like you that make CC Diary such a great tool for mental health support.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct (to be developed).

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for CC Diary. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for CC Diary, 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 or point out the part of CC Diary which the enhancement is related to.
  • Explain why this enhancement would be useful to most CC Diary users.

Your First Code Contribution

Unsure where to begin contributing to CC Diary? You can start by looking through these beginner and help-wanted issues:

  • Beginner 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 beginner issues.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the Flutter/Dart styleguides.
  • End all files with a newline

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

Dart Styleguide

All Dart code must adhere to the official Dart Style Guide.

Documentation Styleguide

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

  • bug - Issues that are bugs.
  • enhancement - Issues that are feature requests.
  • documentation - Issues or pull requests related to documentation.
  • help-wanted - Issues that need assistance from the community or good first issues.

Thank you for contributing to CC Diary!