Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (25 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

41 lines (25 loc) · 2.78 KB

Contributing to SPM

First off, thanks for taking the time to contribute! ❤️

I Have a Question

If you want to ask a question, it is best to search for existing Issues that might help you. You can respond to an issue to contribute to the discussion. There is also a historical mailing list that has many years of contributions from the community. If you can't find any information about how to solve your problem please contribute to SPM so we can improve our software.

Reporting Bugs and Issues

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Make sure that you are using the latest version.
  • Read the relevant documentation.
  • Collect information about the issue:
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
  • Open an Issue.
    • Explain the behavior you would expect and the actual behavior.
    • Provide us with code to reliably reproduce the issue.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for SPM, including new features and minor improvements to existing functionality. Enhancement suggestions are tracked as GitHub issues and following the guidelines below will help us best process your suggestions.

  • Make sure that you are using the latest version of SPM.
  • Perform a search to see if the enhancement has already been suggested.
  • If not, open an enhancement issue with clear and descriptive title to identify the suggestion.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Highlight why the feature will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an independent toolbox.

Making Pull requests and contributing code

If you feel confident in fixing the problem yourself, and are external to the development team, then please create a pull request. In this case please see our developer guidelines on setting up git, our code guidelines and our guide to software testing.

Improving The Documentation

We keep the documentation for SPM separate to the repository. If you would like to add something to our documentation website please raise an issue on the documentation repository.