Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.65 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

We don't maintain a Contributor License Agreement (CLA) but we do require that anyone that wishes to contribute agrees to the following:

  • You have the right to assign the copyright of your contribution.
  • By making your contribution, you are giving up copyright of your contribution.

This application is released under the AGPL 3.0 license, and no single individual or entity owns or will ever own the copyright.

Contribution Workflow

  1. Assign yourself to the issue that you'll be working on. If you'd like to contribute something for which there is no existing issue, consider creating one before you start so we can discuss.
  2. Clone the repository and git checkout master to ensure you are on the master branch.
  3. Create a new branch for your change with git checkout -b <your-branch-name> be descriptive, but terse.
  4. Make your changes. When finished, push your branch with git push origin --set-upstream <your-branch-name>.
  5. Create a pull request to merge <your-branch-name> into master.
  6. A maintainer will review your pull request and may make comments, ask questions, or request changes. When all feedback has been addressed the pull request will be approved, and after all checks have passed it will be merged by a maintainer, or you may merge it yourself if you have the necessary access.
  7. Delete your branch, unless you plan to submit additional pull request from it.

Note that we require that all branches are up to date with target branch prior to merging. If you see a message about this on your pull request, use git fetch to retrieve the latest changes, git merge origin/master to merge the changes from master into your local branch, then git push to update your branch.

Environment Setup

You'll need .NET 6.0 to build and run the back end (slskd), and you'll need Nodejs to build and debug the front end (web).

You're free to use whichever development tools you prefer. If you don't yet have a preference, we recommend the following:

Visual Studio Code for front or back end development.

Visual Studio for back end development.

Debugging

Back End

Run ./bin/watch from the root of the repository.

Front End

Run ./bin/watch --web from the root of the directory. Make sure the back end is running first.