Skip to content

Latest commit

 

History

History
111 lines (72 loc) · 4.96 KB

CONTRIBUTING.md

File metadata and controls

111 lines (72 loc) · 4.96 KB

Contributing Guidelines

Thanks for wanting to help make Hyperamp better! Here are some general guidelines for helping out.

Code of Conduct

This project is intended to be a safe, welcoming space for collaboration. All contributors are expected to adhere to the Contributor Covenant code of conduct. Thank you for being kind to each other!

Contributions welcome!

Before spending lots of time on something, ask for feedback on your idea first!

Please search issues and pull requests before adding something new! This helps avoid duplicating efforts and conversations.

This project welcomes any kind of contribution! Here are a few suggestions:

  • Ideas: participate in an issue thread or start your own to have your voice heard.
  • Writing: contribute your expertise in an area by helping expand the included content.
  • Copy editing: fix typos, clarify language, and generally improve the quality of the content.
  • Formatting: help keep content easy to read with consistent formatting.
  • Code: help maintain and improve the project codebase.

Code Style

standard

This repository uses standard to maintain code style and consistency, and to avoid style arguments.

Developing

Hyperamp is an experimental audio player built with web technologies (choo + electron). We recommend getting familiar with JavaScript, HTML, and CSS before jumping into coding.

Install

This project is a module party. That just means everything you should need to get it up and running after cloning the repository is summed up by these three lines:

npm install
npm test
npm start

TL;DR: before getting started, make sure to run npm install.

Scripts

  • start - start the app in development mode
  • prod - start the app in production mode
  • test - run all tests
  • build - create a test build of the app for debugging purposes
  • pkg - package the production version of the app for release
  • release - create a new release

Directory Structure

These directories are included in the packaged application.

  • lib - files shared by main and renderer
  • main - files for the main electron process
  • renderer - files for the renderer processes (player & audio)

Excluded from Build

These directories are not included in the packaged application.

  • build - build resources for electron-builder
  • dist - this is where the app gets built to when packaging the app
  • docs - any files related to documentation
  • scripts - miscellaneous scripts for development tasks
  • test - files for testing the application

Release Process

  1. Ensure all tests are passing.
  2. Create the new version section in CHANGELOG.md.
  3. Bump the version in package.json. Should match the version you just created in CHANGELOG.md.
  4. Run npm run release. This will create a github release draft.
  5. Travis-CI (for Linux and Mac) and Appveyor (for Windows) will start uploading builds to the release draft.
  6. Wait for uploads to finish. Check that everything worked during build by checking CI logs.
  7. Make sure tag format is vX.X.X (auto-update is picky about URL names).
  8. Publish the draft.
  9. Clients will automatically download the new version next time they start.

Our release process is based on electron-builder's Recommended GitHub Releases Workflow.

Project Governance

This is an OPEN Open Source Project.

Individuals making significant and valuable contributions are given commit access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

Rules

There are a few basic ground rules for collaborators:

  1. No --force pushes to master or modifying the Git history in any way.
  2. Non-master branches ought to be used for ongoing work.
  3. External API changes and significant modifications ought to be subject to an internal pull request to solicit feedback from other contributors.
  4. Internal pull requests to solicit feedback are encouraged for any other non-trivial contribution but left to the discretion of the contributor.
  5. Contributors should attempt to adhere to the prevailing code style.

Releases

Declaring formal releases remains the prerogative of the project maintainer.

Changes to this arrangement

This is an experiment and feedback is welcome! This document may also be subject to pull requests or changes by contributors where you believe you have something valuable to add or change.