Skip to content

Latest commit

 

History

History
93 lines (65 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

93 lines (65 loc) · 3.7 KB
Raw

Contributing to ConTextCap

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

Code of Conduct

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

  • Use welcoming and inclusive language
  • Be respectful of differing viewpoints and experiences
  • Gracefully accept constructive criticism
  • Focus on what is best for the community
  • Show empathy towards other community members

How Can I Contribute?

Reporting Bugs

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

Before Submitting A Bug Report:

  • Check the documentation for a list of common questions and problems
  • Ensure the bug was not already reported by searching on GitHub under Issues

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots and animated GIFs if possible

Suggesting Enhancements

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

Before Submitting An Enhancement Suggestion:

  • Check if there's already a package which provides that enhancement
  • Determine which repository the enhancement should be suggested in
  • Check if the enhancement has already been suggested

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead
  • Explain why this enhancement would be useful to most ConTextCap users

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 Python styleguide
  • Include thoughtfully-worded, well-structured tests
  • Document new code
  • 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

Python Styleguide

  • Follow PEP 8
  • Use 4 spaces for indentation
  • Use docstrings for all public classes, methods, and functions
  • Keep lines under 80 characters
  • Use meaningful variable names

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
  • documentation - Issues for improving or updating our documentation
  • enhancement - Issues for new features or improvements
  • help-wanted - Issues which need extra attention
  • question - Issues which are questions or need clarification
  • wontfix - Issues which we've decided not to fix for now