Skip to content

Commit

Permalink
Minor
Browse files Browse the repository at this point in the history
  • Loading branch information
nikitabobko committed Oct 27, 2024
1 parent 7e46cbe commit b95c13e
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 17 deletions.
12 changes: 8 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@ Look who wants to contribute! Nice to see you here, let me show you what you can

## Report Issues

* It's ok to use issues to ask questions. But please make sure to read:
* The guide https://nikitabobko.github.io/AeroSpace/guide
* Commands reference https://nikitabobko.github.io/AeroSpace/commands
There are only two types of issues:
* Feature proposal
* Bug report

Feature proposal is not a feature request/idea but a well-defined and complete proposal of feature which is clear how to implement.
If you're unsure you can brainstorm your ideas in [#feature-ideas](https://github.com/nikitabobko/AeroSpace/discussions/categories/feature-ideas) in GitHub Discusssions.

Rules:
* Search for duplicates before reporting new issues
* Vote for duplicates with 👍 reaction
* Vote for issues that you find useful with 👍 reaction

**Consider including in bug reports**
Expand Down
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ let package = Package(
.library(name: "AppBundle", targets: ["AppBundle"]),
],
dependencies: [
.package(url: "https://github.com/InerziaSoft/ISSoundAdditions", from: "2.0.1"),
.package(url: "https://github.com/InerziaSoft/ISSoundAdditions", exact: "2.0.1"),
.package(url: "https://github.com/Kitura/BlueSocket", exact: "2.0.4"),
.package(url: "https://github.com/soffes/HotKey", exact: "0.1.3"),
.package(url: "https://github.com/LebJe/TOMLKit", exact: "0.5.5"),
Expand Down
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,35 @@ Other installation options: https://nikitabobko.github.io/AeroSpace/guide#instal
> automatically delete `com.apple.quarantine` attribute, that's why the app should work out of the box, without any warnings that
> "Apple cannot check AeroSpace for malicious software"
## Contributing, creating issues, submitting pull requests

## Community, discussions, issues, pull requests

Informal community discussions happen at [GitHub Discussions](https://github.com/nikitabobko/AeroSpace/discussions).
There you can ask your questions, show off your setup, bring other topic, or just chat.

There are 5 channels:
- [#announcements](https://github.com/nikitabobko/AeroSpace/discussions/categories/announcements).
[RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/announcements.atom).
Only maintainers can post here.
Highly moderated traffic.
- [#announcements-releases](https://github.com/nikitabobko/AeroSpace/discussions/categories/announcements-releases).
[RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/announcements-releases.atom).
Announcements about non-patch releases.
Only maintainers can post here.
- [#feature-ideas](https://github.com/nikitabobko/AeroSpace/discussions/categories/feature-ideas).
[RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/feature-ideas.atom).
- [#general](https://github.com/nikitabobko/AeroSpace/discussions/categories/general).
[RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/general.atom).
- [#questions-and-answers](https://github.com/nikitabobko/AeroSpace/discussions/categories/questions-and-answers).
[RSS](https://github.com/nikitabobko/AeroSpace/discussions/categories/questions-and-answers.atom).
Everyone is welcome to ask questions.
Everyone is encouraged to answer other people's questions.

You're welcome to submit bug reports and well-defined feature proposals in GitHub issues.
You're welcome to submit pull requests as well.
See: [CONTRIBUTING.md](./CONTRIBUTING.md)

**Issues vs Discussions:** Issues are more formal and well-defined requests. Discussions are informal and casual.

## Development

A notes on how to setup the project, build it, how to run the tests, etc. can be found here: [dev-docs/development.md](./dev-docs/development.md)
Expand All @@ -76,10 +101,11 @@ A notes on how to setup the project, build it, how to run the tests, etc. can be
For advanced users, it's easier to edit a configuration file in text editor rather than navigating through checkboxes in GUI.
- Status menu icon is ok, because visual feedback is needed
- Provide _practical_ features. Fancy appearance features are not _practical_ (e.g. window borders, transparency, animations, etc.)
- If "dark magic" (aka "private APIs", "code injections", etc) can be avoided, it must be avoided
- "dark magic" (aka "private APIs", "code injections", etc.) must be avoided as much as possible
- Right now, AeroSpace uses only a single private API to get window ID of accessibility object `_AXUIElementGetWindow`.
Everything else is [macOS public accessibility API](https://developer.apple.com/documentation/applicationservices/axuielement_h).
- AeroSpace will never require you to disable SIP (System Integrity Protection).
- The goal is to make AeroSpace easily maintainable, and resistant to macOS updates.

**Non Values**
- Play nicely with existing macOS features.
Expand Down
4 changes: 2 additions & 2 deletions Sources/Common/cmdArgs/impl/ListAppsCmdArgs.swift
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ public struct ListAppsCmdArgs: CmdArgs {
],
arguments: [],
conflictingOptions: [
["--format", "--count"],
["--json", "--count"],
["--count", "--format"],
["--count", "--json"],
]
)

Expand Down
4 changes: 2 additions & 2 deletions Sources/Common/cmdArgs/impl/ListMonitorsCmdArgs.swift
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ public struct ListMonitorsCmdArgs: CmdArgs {
],
arguments: [],
conflictingOptions: [
["--format", "--count"],
["--json", "--count"],
["--count", "--format"],
["--count", "--json"],
]
)

Expand Down
4 changes: 2 additions & 2 deletions Sources/Common/cmdArgs/impl/ListWindowsCmdArgs.swift
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ public struct ListWindowsCmdArgs: CmdArgs {
conflictingOptions: [
["--all", "--focused", "--workspace"],
["--all", "--focused", "--monitor"],
["--format", "--count"],
["--json", "--count"],
["--count", "--format"],
["--count", "--json"],
]
)

Expand Down
4 changes: 2 additions & 2 deletions Sources/Common/cmdArgs/impl/ListWorkspacesCmdArgs.swift
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ public struct ListWorkspacesCmdArgs: CmdArgs {
arguments: [],
conflictingOptions: [
["--all", "--focused", "--monitor"],
["--format", "--count"],
["--json", "--count"],
["--count", "--format"],
["--count", "--json"],
]
)

Expand Down
2 changes: 1 addition & 1 deletion dev-docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,5 @@ Even if you use LSP and another text editor, Xcode is still useful to attach deb
## Tips

- Use built-in "Accessibility Inspector.app" to inspect accessibility properties of windows
- Use [BetterDisplay 2](https://github.com/waydabber/BetterDisplay) to emulate several monitors
- Use [DeskPad](https://github.com/Stengo/DeskPad) or [BetterDisplay 2](https://github.com/waydabber/BetterDisplay) to emulate several monitors
- You can use `script/clean-project.sh` to clean the project when something goes wrong.

0 comments on commit b95c13e

Please sign in to comment.