Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

57 lines (44 loc) · 2.71 KB

Contributing to ManagedBass

There are various ways to contribute to the development of ManagedBass. Thank you for your interest in the same.
Here are some guidelines which would help us build better software together.

Questions and Discussions - Gitter

You can always Chat on Gitter. If your issues are related to BASS itself, you could ask for help on BASS Forums.

Reporting Bugs - Issues

  • Check if a similar issue is already reported. If so then comment on that issue with details specific to your case.
  • Check if the issue is resolved in the latest NuGet release or in this repository.
  • Report the OS and .Net/Mono/Xamarin version on which you are running ManagedBass.
  • Also, Report your IDE.
  • Include details of included bass Libraries(dll/so/dylib) and whether they are 32-bit, 64-bit, ARM, etc.
  • If possible, Include steps to replicate the problem or a sample project.

Code - Pull Requests

  1. Fork a repository you want to contribute to.
  2. Create a new branch.
  3. Push your changes.
  4. Create Pull Request.
  • Make sure to follow the Code-Style followed throughout ManagedBass.
  • Make use of latest C# features and ReSharper.
  • Thoroughly test your work.
  • If you intend to bring a major change, you would have to be around helping to resolve issues which arise with other users of your work.

Very Important

If you intend to make a big change, create a Pull Request early and include (WIP) in its title.

  • So that everyone knows what you are working so that there are no redundancies.
  • To know before-hand if what you intend to do goes well with the Roadmap of the project.

You could still send a Pull Request even if you are uncomfortable with the guidelines. We would help you to make your code comply with our guidelines.

Samples

Set up a repository and transfer it to ManagedBass organisation. Make sure that if you include a LICENSE file, then it must be an MIT License.

Join Us

If you are willing to contribute to ManagedBass in the long term, join the organisation.

Stars

The simplest way to contribute is to Star the repositories.

Documentation

Documentation too is a good way to contribute.

Website

The Website containing API Documentation is generated from ManagedBass.DocFX repository.

Test

Testing the libraries would also be a huge help.

Gratipay

ManagedBass is a free alternative to the paid Bass.Net library and is made and maintained in personal time. If you feel generous, you could donate to the Gratipay team or Mathew Sachin on PayPal to show your support.