Look who wants to contribute! Nice to see you here, let me show you what you can do :)
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 in GitHub Discusssions.
Rules:
- Search for duplicates before reporting new issues
- Vote for issues that you find useful with 👍 reaction
Consider including in bug reports
aerospace debug-windowsoutput, 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
- Alternative command names, if you suggest a new command
One of the most useful thing you can do is to discuss issues.
Imagine that you were assigned to fix the issue. Try to suggest the best approach and design on how to fix the issue. Suggest the synopsis/config format, reason in written form what is good about it, what is bad about it, what are the alternatives, etc. Basically, see the "Prior discussion" section in Submit Pull Requests :)
If you have something to contribute to the conversation. Do it!
Please keep the conversation to the point. Discuss one issue at a time, crossreference other issues
You can take a look at the following issues:
- Most voted issues: https://github.com/nikitabobko/AeroSpace/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc
- Sometimes conversations happen on old issues that aren’t yet closed. See https://github.com/nikitabobko/AeroSpace/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
- Issues that are unclear on how to fix, or issues that require design of the interface (CLI or config interface) are tagged with
design-neededtag https://github.com/nikitabobko/AeroSpace/issues?q=is%3Aissue+is%3Aopen+label%3Adesign-needed
Prior discussion. For non-trivial changes (such as user visible changes), it's always better to ask for prior approval and discuss what you want to do before doing it.
Please create an issue (or write a comment in existing one) and describe you want to do.
Consider including
- What users will observe after your change?
- Feature interaction with existing features or potential future features
- What use cases does it cover
- What is the proposed syntax for the config
- What is the proposed synopsis of CLI command
- How you think it should be implemented (if you can describe it)
- etc.
Discussing that you want to do something doesn't put any obligations on you. If you don't want to start the discussion just because you're afraid that you won't do it. Don't be afraid!
Small and trivial improvements can be submitted without any discussion.
Commit hygiene. Each submitted commit must be atomic change (a Pull Request may contain several commits). Don't introduce new functional changes together with refactorings in the same commit.
Similarly, when implementing features and bug fixes, please stick to the structure of the codebase as much as possible and do not take this as an opportunity to do some "refactoring along the way".
A good commit message also mentions the motivation of the change (the commit describes what, why and how)
License Agreement. By contributing changes to this repository, you agree to license your contributions under the MIT license.
Maintainers can merge your pull request with arbitrary modifications.
Pull request merge. It cannot be guaranteed that your pull request will be merged. Be ready that your pull request might be rejected because the implementation isn't good, or the approach is incorrect.
The prior discussion is here for you to minimize the risk of rejection.
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
Submit your tips to the Goodness page. The source code of the page can be found in ./docs directory
Supporting the project financially counts as a contribution (even if it's just a $1/month). https://github.com/sponsors/nikitabobko