Contribute & Support🔗︎

If you find the project useful, then consider sponsoring what you can, even a cup of coffee to get through debugging a new feature.

Bug Reports🔗︎

Try to read the documents and search the issue tracker to find answers before posting a new issue.
Follow the template in the issue ticket and include all details requested.
Be prepared to answer questions or give additional information. Issues where the creator does not follow up to questions will be marked stale and closed.

Issue Tickets🔗︎

Help answer questions in issue tickets. Share your experience to help others by offering suggestions and solutions in issues.

Test Features🔗︎

Test features on different devices and systems. Report on items not working as intended, or help debug and diagnose issues.

Improve Documents🔗︎

If the documents are lacking or there is a typo, consider improving it or open an issue ticket if you are not comfortable digging into a full Github Pull Request. Translating PineSAM into different languages is another way to help.

Review Code🔗︎

Make suggestions that improve code, error handling, and algorithms. Participate in code review of pull requests and direct commits.

Pull Requests🔗︎

Code contributions are welcome. Just fork the code and submit well commented and clean commits to the repository. Perform a pull pequests (pr) to the /dev branch. Check out some of the open issue tickets or propose new features. If there is no existing ticket related to the PR, then create a ticket outlining what issues are being addressed.

MIT License🔗︎

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.