Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (43 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 2.19 KB
Raw

Contributing

The main and the most important rule: read the room!

  • Does your patch look like typical commit in the repo?
  • Does your commit message look like typical commit message in the repo?
  • Does your test look like typical test in the repo?
  • etc.

Submiting bugs and feature ideas

Submit bugs to https://github.com/nikitabobko/AeroSpace/discussions/categories/potential-bugs

Submit feature ideas to https://github.com/nikitabobko/AeroSpace/discussions/categories/feature-ideas

Rules:

  • Search for duplicates (in GitHub Issues and Discussions) before creating a new discussion
  • Upvote for issues/discussions that you find useful

Consider including in bug reports

  • aerospace debug-windows output, if the problem is about handling some windows
  • Screenshots of problematic windows
  • Videos of problematic windows
  • What did you try to resolve the issue?
  • Your config
  • AeroSpace version
  • macOS version

Consider including in feature request

  • Use cases!
  • Alternative approaches
  • Links to docs of similar features in other window managers that you know
  • Synopsis, if you suggest a new command
  • Mental model description

Submiting code

There are 2 options:

  1. Send email patches to: echo YWVyb3NwYWNlLXBhdGNoZXNAYm9ia28ueHl6Cg== | base64 --decode
  2. Send GitHub PRs

License Agreement. By contributing changes to this repository, you agree to license your contributions under the MIT license.

Maintainers can apply your patch with arbitrary modifications.

Spread the word

Do you like the project? Does AeroSpace finally fix your problems with windows management on macOS? Good to hear it!

  • Spread the word in social networks! (Don't forget to share the link :) )
  • Talk about AeroSpace to your colleagues and friends
  • Write a blogpost about your workflows
  • Record a YouTube video

Share your workflow and tips

Submit your tips to the Goodies page. The source code of the page can be found in ./docs directory

Support the project financially

Supporting the project financially counts as a contribution (even if it's just a $1/month). You can sponsor the project on GitHub Sponsors page: https://github.com/sponsors/nikitabobko