Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (58 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

84 lines (58 loc) · 3 KB

Contributing to Bump Service

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

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I 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
  • 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 logs if relevant

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • 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

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 Rust styleguides
  • End files with a newline
  • Avoid platform-dependent code

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

Rust Styleguide

  • Use cargo fmt to format your code
  • Run cargo clippy and address all warnings
  • Follow the Rust API Guidelines
  • Write documentation for public APIs
  • Include unit tests when adding new features

Documentation Styleguide

  • Use Markdown
  • Reference functions and variables with backticks: `myFunction()`
  • Document the purpose of each module and significant functions

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 for bugs in the codebase
  • documentation - Issues for improving or updating our documentation
  • enhancement - Issues for new features or improvements
  • good first issue - Good for newcomers
  • help wanted - Extra attention is needed
  • performance - Related to performance improvements
  • work-in-progress - Pull requests that are still being worked on

Getting Help

If you need help, you can: