-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
6 additions
and
705 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,8 @@ | ||
I'm writing this document to help set the expectations of developers looking to add features they wrote to deej's main fork. | ||
Unlike the previous maintainer, I don't care about what you're doing, I only ask that: | ||
|
||
I hope that even though not everyone would be happy about my approach to this subject, we'll be able to have a civil and respectful discussion around it. If you're interested in doing so, I invite you to reach out to me via our community [Discord server](https://discord.gg/nf88NJu). | ||
1. You make your PRs readable and are clear about what you're wanting to add and why. | ||
2. New features and bugfixes are king, I'll get to your PRs/patches as I can | ||
3. This is software, it has bug, expect bugs | ||
4. Cross platform is a nicety, not everything will work for your platform | ||
5. Linux will get priority as I don't have any windows machines anymore, this does not mean that OSX and windows are "deprecated" I simply do not have the power to personally test on those platforms. (Hint: that means I will be looking for people who I can trust to test and provide feedback on those platforms) | ||
|
||
Thanks for reading! | ||
|
||
## Some background, and my vision for deej | ||
|
||
Similarly to other software developers who maintain open-source projects outside of their workplace, I work on deej - for free - in my free time, motivation and mood permitting. | ||
|
||
A lot of that time is spent interacting outside of GitHub, by running our community Discord server which is an active space with over a thousand members. This includes supporting users with their initial setup of deej, answering questions about deej and commenting on user-created builds and designs. | ||
|
||
Since the project's initial debut in February 2020, I had the pleasure of talking to hundreds of users - beginners and seasoned developers alike - which has guided my decisions on subjects like licensing and documentation, as well as helped me form the following vision for deej's future: | ||
|
||
### Project scope | ||
|
||
I have a fairly set vision for deej and what it should be (including at which point in time I'd like to add certain things). I prefer to work on these things myself - as mentioned above, when I have the time and motivation to do so. | ||
|
||
### Project audience | ||
|
||
Many of deej's users aren't necessarily tech-savvy, and for some of them this is their first time making a combined electronics hardware + software project. This fact influences many decisions vis-a-vis keeping things as simple as possible. I care a lot about beginners being able to get started easily, even at the cost of certain more advanced features not being included in vanilla deej. | ||
|
||
## Pull requests and alternate forks | ||
|
||
The nature of how I currently choose to maintain deej means that **I'm not likely to accept and incorporate PRs** into deej's main fork ([omriharel/deej](https://github.com/Red-M/ReeeMiks)). | ||
|
||
Despite the above, **deej is still a fully open-source project**. I don't want my occasional lack of energy to stand in the way of anyone looking to make something awesome - you have my blessing to fork the project, maintain your copy of it separately, and tell the world (_including_ our community Discord server) about it! | ||
|
||
### Getting started with development | ||
|
||
- Have a Go 1.14+ environment | ||
- Use the build scripts under `pkg/deej/scripts` for your built binaries if you want them to have the notion of versioning | ||
|
||
## Issues | ||
|
||
I welcome all bug reports and feature requests, and try to respond to these within a reasonable amount of time. |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.