radex
/
jspaint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

main
Isaiah Odhner 2018-01-23 18:56:55 -05:00 committed by GitHub
parent fbd62a04d0
commit 712d113e92
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
CONTRIBUTING.md
View File

@ -1,14 +1,38 @@
# Contributing
Just let me know before you work on something by opening an issue or commenting on an existing one.
#### Pull Requests
Let me know before you work on something by opening an issue or commenting on an existing one.
I don't want your effort to be wasted!
Open issues! Issues for features, issues for problems...
#### Issues
Open issues! Search for issues first, but open issues for features, issues for problems...
Feel free to open issues in a "meta" context, like "hey, maybe you should tag issues with 'good first issue'" etc.
https://github.com/1j01/jspaint/issues
You can also just [email me](mailto:isaiahodhner@gmail.com) if you prefer (and I'll probably create an issue).
#### Windows 98
JS Paint's GUI is primarily based on Paint from Windows 98.
There's a nice [online emulator here](https://copy.sh/v86/?profile=windows98)
that you can play around with and/or use as a reference.
You can open issues relating to that UI, but also for general functionality that isn't necessarily in mspaint,
for instance jspaint already has affordances like unlimited undos, extra menu items, and shortcut-like features.
## Dev Setup
* Install Node.js if you don't have it (and maybe update it)
* Clone the repo
* Install dependencies with `npm i`
* Run `npm run dev` to start up a live-reloading web server
### Project Structure
it's messy; a lot of stuff is in a file simply called "functions.js" (to give you an idea of it)
It's messy. A lot of stuff is in a file simply called "functions.js", to give you an idea of it.
I can go into more detail [if you want..](https://github.com/1j01/jspaint/issues)