Comments (19)
@shakeelmohamed Thanks, I'll get started on that this Monday.
from zen-audio-player.github.io.
@shakeelmohamed I was just thinking the other day a list would be great. I'm away this weekend, but I'll hop on that Monday evening!
from zen-audio-player.github.io.
Created a wiki, and added a Use Cases page as a start - hopefully more research will lead to more insight!
from zen-audio-player.github.io.
Some general topics that would be helpful:
- How to get started quickly as a newbie
- How to test things locally (WAMP, MAMP, XAMPP) vs. opening the
index.html
file in a browser - How to write tests
- What are our code conventions/style? (a
.jshintrc
would help a bunch here) - How to install dependencies (frontend & test)
- How to run tests
- What to look for in a success/errored work session
- What is the contributing process like? (@shakeelmohamed's code review on the PR, contributor updates PR, repeat until everyone is satisfied)
- Branching model (basically master is locked down, and can only be pushed to via a PR that passes code review)
- Tools (why did we pick certain things? bower/node.js/specific dependencies/gitter/travis CI)
from zen-audio-player.github.io.
I'm happy to write the part on testing things locally. I may get some time this weekend - I'm pushing a site live tomorrow for a client (outside of my day job) so I've been out of action all this week. =\
from zen-audio-player.github.io.
Rock on @BeigeBadger!
from zen-audio-player.github.io.
What's the progress on this so far? Ironically, I'm a newbie (at Zen Audio Player) and I'm looking for an approachable issue to tackle. I was wondering if docs would be a good place to start. :)
from zen-audio-player.github.io.
Welcome @josectello! Beyond README.md
and CONTRIBUTING.md
, there's a few loose ends on the wiki. See if you can add a new page there just to test it, I may need to give you permissions
from zen-audio-player.github.io.
Thanks @shakeelmohamed. I went ahead and made a minor change to the front page of the wiki (mainly formatting), let me know if that looks alright!
As for CONTRIBUTING.md
, is that something you guys would want to have in the repo? If so, I can fork and begin drafting something that expands more on contributions than the Contributions
page of the wiki.
from zen-audio-player.github.io.
Thanks @josectello, glad you have permissions - I've added you to the org!
We actually need the CONTRIBUTING.md
file to show the banner you see when creating a new issue or pull request. We might want to reduce the contents of the file and move some content to the wiki, I think the length of the file may be intimidating to new users. What do you think about that?
from zen-audio-player.github.io.
I think I got it. So we want a quick start guide with maybe some screenshots of submitting a PR/issue for clarity to new users. Yeah I think that's a great idea.
Just making sure, there isn't currently a CONTRIBUTING.md
, right? I looked through and didn't appear to find one.
from zen-audio-player.github.io.
@josectello it's actually in the .github
directory, I forgot we moved it
from zen-audio-player.github.io.
Work has been keeping me very busy for the past few days. Hopefully I will begin to work on this tomorrow.
from zen-audio-player.github.io.
No worries @josectello
from zen-audio-player.github.io.
@josectello Do you want to triage the the comments/description in this issue? I'd like to see 2 lists, todo & done.
from zen-audio-player.github.io.
@josectello perfect, thanks a ton!
from zen-audio-player.github.io.
@shakeelmohamed Would it be easier to open up a new issue with a list of tasks that can be ticked off in markdown? I don't think I can edit any comments/descriptions on here except my own.
from zen-audio-player.github.io.
@josectello yep that would be perfect
from zen-audio-player.github.io.
Closing in favor of #201, which is more organized thanks to @josectello
from zen-audio-player.github.io.
Related Issues (20)
- Add a "Focus" button HOT 3
- Adjusting the Sponsors HOT 1
- Remove Keen from readme HOT 2
- Functionality is totally broken HOT 6
- Repeat track does not repeat when clicking towards end of song HOT 9
- Clicking near focus button redirects to another url HOT 2
- Sponsors isn't adjusted at 760x800 resolutions. HOT 4
- Remove CNAME file HOT 4
- The size of the input window and the search button are different at 475x625. HOT 3
- Add shortcuts for "community favorites" HOT 4
- GitHub icon is not centered horizontally HOT 3
- adding dark theme HOT 6
- Adding navbar and improving UI HOT 9
- Adding a feature "Favourites" and authentication HOT 2
- Redesign the README.md file HOT 2
- Fix the known vulnerabilities badge
- Fix code scanning alert - Client-side cross-site scripting HOT 3
- Fix code scanning alert - Incomplete string escaping or encoding HOT 1
- Setup dev deployments to Vercel HOT 1
- Search Suggestions Cursor HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from zen-audio-player.github.io.