Contributing¶

Thank you for wanting to contribute to the PolyPlug project!

Working together¶

The PolyPlug Code of Conduct governs the project and everyone participating in it. By participating, you are expected to uphold this code. Please report unacceptable behavior to the maintainers or administrators as described in that document.

Activities¶

Reporting bugs¶

Bugs are tracked on the project issues page. Please check if your issue has already been filed by someone else by searching the existing issues before filing a new one. Once your issue is filed, it will be triaged by another contributor or maintainer. If there are questions raised about your issue, please respond promptly.

Creating useful issues¶

  • Use a clear and descriptive title.

  • Describe the specific steps that reproduce the problem with as many details as possible so that someone can verify the issue.

  • Describe the behavior you observed, and the behavior you had expected.

  • Include screenshots if they help make the issue clear.

Reporting security issues¶

If you aren’t confident that it is appropriate to submit a security issue using the above process, you can e-mail it to security@pyscript.net

Asking questions¶

If you have questions about the project, using PolyPlug, or anything else, please ask in the PolyPlug forum.

Places to start¶

If you would like to contribute to PolyPlug, but you aren’t sure where to begin, here are some suggestions.

  • Read over the existing documentation. Are there things missing, or could they be clearer? Make some changes/additions to those documents.

  • Review the open issues. Are they clear? Can you reproduce them? You can add comments, clarifications, or additions to those issues. If you think you have an idea of how to address the issue, submit a fix!

  • Look over the open pull requests. Do you have comments or suggestions for the proposed changes? Add them.

  • Check out the examples. Is there a use case that would be good to have sample code for? Create an example for it.

Setting up your local environment and developing¶

If you would like to contribute to PolyPlug, you will need to set up a local development environment. The instructions are in the README.

License terms for contributions¶

This Project welcomes contributions, suggestions, and feedback. All contributions, suggestions, and feedback you submitted are accepted under the Apache 2.0 license. You represent that if you do not own copyright in the code that you have the authority to submit it under the Apache 2.0 license. All feedback, suggestions, or contributions are not confidential.

Becoming a maintainer¶

Contributors are invited to be maintainers of the project by demonstrating good decision making in their contributions, a commitment to the goals of the project, and consistent adherence to the code of conduct. New maintainers are invited by a 3/4 vote of the existing maintainers.

Trademarks¶

The Project abides by the Organization’s trademark policy.

Part of MVG-0.1-beta. Made with love by GitHub. Licensed under the CC-BY 4.0 License.