Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (41 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.43 KB
Raw

Contributing to DevLok

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to DevLok. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

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

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for DevLok. 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 much detail as possible.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for DevLok, 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 much detail as possible.
  • Explain why this enhancement would be useful to most DevLok 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 style guides of the project.

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

Frontend Styleguide

  • We use Prettier and ESLint. Please ensure your code is formatted before committing.
  • Run pnpm format in apps/client to format your code.

Backend Styleguide

  • We follow PEP 8.
  • Use Pyright for type checking.

Development Workflow

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

License

By contributing, you agree that your contributions will be licensed under its MIT License.