Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

62 lines (38 loc) · 2.97 KB
Raw

Contributing to Zufall Labs Projects

First off, thank you for considering contributing to our projects! It's people like you that make our organization great. We welcome contributions from everyone, and we are grateful for even the smallest of fixes!

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. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use the GitHub issue search — check if the issue has already been reported.
  • Check if the issue has been fixed — try to reproduce it using the latest main or development branch in the repository.
  • Isolate the problem — create a reduced test case and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.

Suggesting Enhancements

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

  • Use the GitHub issue search — check if the enhancement has already been suggested.
  • Check if the enhancement has already been implemented — try to reproduce it using the latest main or development branch in the repository.
  • Suggest your change in a new issue on GitHub.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through these good first issue 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 good first issue 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 style guides
  • Document new code based on the Documentation Styleguide
  • End all files with a newline

Style Guides

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

[Language] Style Guide

Follow the style guide for each language as listed in each project repository respectively. This may change from project to project and repository to repository.

Questions?

If you have any questions, please feel free to contact the project maintainers.

Thank you for contributing to Zufall!