Skip to content

Latest commit

 

History

History
29 lines (27 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

29 lines (27 loc) · 1.68 KB

contributing

thank you for showing interest in the development of this project. by contributing, you agree to these guidelines

  • issues::
    • before opening a new issue, try searching existing issues first
    • when submitting a bug report::
      • make sure you are on the latest version of the app in case the bug has already been patched
      • explicitly state what version of the app you are using (find it on line 30 of your local expanse/compose.prod.yaml)
      • try to include as much detail as possible, relevant logs, and steps to reproduce the bug
    • please answer follow up questions, if any, in a timely manner
    • refrain from posting "+1" comments. use the thumbs reaction instead
  • PRs::
    • before starting a new PR, try searching existing issues and PRs first
    • what PRs are accepted?
      • ✅ usually accept::
        • bug/security/typo fixes
      • ⚠️ discussion first::
        • large PRs
        • new features
      • ❌ won't accept::
        • buggy/breaking changes
        • unfitting UI/UX
    • when submitting a PR::
      • try to include as much detail as possible of what changes you are proposing
      • try to adhere to the existing code syntax/style
      • double check and test changes before committing
      • keep the "Allow edits from maintainers" checkbox checked to allow maintainer pushes to your PR branch
    • any code accepted into this project may be adapted into other works in the future. if your code is used, you will be co-authored in the commit