Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.47 KB
Raw

Contributing to MiNAA

The following guidelines are designed for contributors to MiNAA.

Reporting Issues and Questions

For reporting a bug, a failed function or requesting a new feature, open an issue in GitHub's issue tracker. First, seach through existing issues (open or closed) that might have the answer to your question.

When reporting a bug, it is most helpful to include:

  • A quick background/summary
  • Specific steps to reproduce, with sample code if you can
  • The expected result
  • The actual result
  • Notes (i.e. why you think this might be happening, or things you tried that didn't work)

Contributing Code

To make contributions to MiNAA, request your changes or contributions via a pull request against the development branch of the MiNAA repository.

Please use the following steps:

  1. Fork the MiNAA repository to your GitHub account
  2. Clone your fork locally with git clone
  3. Create a new branch with a name that describes your contribution. For example, if your contribution is a bug fix in fileio.cpp, your new branch can be named bugfix/fileio. You can create and switch to it with git checkout -b bugfix/fileio
  4. Make your changes on this new branch.
  5. Push your changes to your fork.
  6. Submit a pull request against the development branch in MiNAA.

License

By contributing, you agree that your contributions will be licensed under its MIT License.