Skip to content

Latest commit

 

History

History
97 lines (67 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

97 lines (67 loc) · 2.9 KB

Contributing to Back.Serv

First off, thank you for considering contributing to Back.Serv! It's people like you that make Back.Serv 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 existing issues 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 screenshots if possible

Suggesting Enhancements

If you have a suggestion for a new feature or enhancement, first check the existing issues and pull requests to see if someone else has already suggested it. If not, create a new issue with:

  • A clear and descriptive title
  • A detailed description of the proposed feature
  • Any possible drawbacks or challenges you can think of
  • If possible, a rough proposal of how to implement it

Pull Requests

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, update the documentation
  4. Ensure the test suite passes
  5. Make sure your code lints
  6. Issue that pull request!

Development Process

  1. Create a new branch:

    git checkout -b feature/your-feature-name

  2. Make your changes and commit them:

    git commit -m 'Add some feature'

  3. Push to your fork:

    git push origin feature/your-feature-name

  4. Open a Pull Request

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 meaningful variable names
  • Write docstrings for all public methods and classes
  • Keep functions focused and single-purpose
  • Add comments for complex logic

Documentation Styleguide

  • Use Markdown for documentation
  • Keep language clear and concise
  • Include code examples where appropriate
  • Update README.md with any new features

Additional Notes

Issue and Pull Request Labels

  • bug: Something isn't working
  • enhancement: New feature or request
  • documentation: Improvements or additions to documentation
  • good first issue: Good for newcomers
  • help wanted: Extra attention is needed

Recognition

Contributors who make significant improvements will be added to the README.md acknowledgments section.

Thank you for contributing to Back.Serv!