Skip to content

Latest commit

 

History

History
94 lines (54 loc) · 3.08 KB

contributing.md

File metadata and controls

94 lines (54 loc) · 3.08 KB
Raw

Swing Music Contributing Guide

Hi! We're really excited that you are interested in contributing to Swing Music. This project uses Python, Flask, Sqlite, Poetry, and Vue.

If you are interested in making a code contribution take a moment to read through the following guidelines:

Pull Request Guidelines

  • Checkout a topic branch from the relevant branch, e.g. master, and merge back against that branch.

  • If adding a new feature:

    • Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.

  • If fixing bug:

    • Provide a detailed description of the bug in the PR.

Development Setup

This project is broken down into 2 parts. The server (this repo) and the client (which lives here).

To contribute to the server development, you need to install Poetry package manager.

Fork this repo, git clone and install the dependencies:

git clone https://github.com/swing-opensource/swingmusic.git

# or with ssh

git clone git@github.com:swing-opensource/swingmusic.git

cd swingmusic

poetry install

Finally, run the server. You can use a different port if you have another Swing Music instance running on port 1970.

poetry run python manage.py --port 1980

After that, checkout into a new branch and make your changes.

git checkout <branch_name>

Finally, commit your changes and open a pull request.

Contributing to the client

You need to have yarn installed in your machine. See their install guide.

Fork the repo, git clone and install the dependencies:

git clone https://github.com/swing-opensource/swingmusic-client.git

# or with ssh

git clone git@github.com:swing-opensource/swingmusic-client.git

cd swingmusic-client

yarn install

You can now run the client.

yarn dev

You can see the client at http://localhost:5173.

The client is hardcoded to hook into the server on port 1980 (to allow the another server instance to be running on the default port).

You can follow the instructions above to set up the server in that port, or you can change the port in swingmusic-client/config.ts. Don't forget to change it back when in the PR.

Where can I go for help?

If you need help, you can find other contributors on the Swing Music Community group on Telegram.

What does the Code of Conduct mean for me?

Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.

See you around?