Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 3.4 KB

Contributing to Cluster Headache Tracker

First off, thank you for considering contributing to Cluster Headache Tracker! It's people like you that make Cluster Headache Tracker such a great tool.

Code of Conduct

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

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Cluster Headache Tracker. 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 Cluster Headache Tracker, 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.

Your First Code Contribution

Unsure where to begin contributing to Cluster Headache Tracker? 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 Ruby 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

Privacy and Data Handling Guidelines

When contributing to Cluster Headache Tracker, please keep in mind our commitment to user privacy:

  1. Do not introduce any features that collect personally identifiable information.
  2. Ensure that any new data storage or processing happens on EU-based servers (preferably in Germany).
  3. Maintain the use of usernames for user identification, avoiding the introduction of email-based identification.
  4. When adding new features, consider their privacy implications and document any potential privacy concerns in your pull request.
  5. If you're unsure about the privacy implications of a feature you're working on, please ask for guidance in the issue or pull request.

License Compliance

Cluster Headache Tracker is licensed under the GNU General Public License v3.0 (GPL-3.0). When contributing, please ensure that your contributions are compatible with this license. If you're introducing code from external sources, make sure it's also GPL-3.0 compatible and properly attributed.

Thank you for helping keep Cluster Headache Tracker private, secure, and open-source!