How to contribute to Pinax

1st September 2015 / by Anna Ossowski in How Tos

Would you like to contribute to Pinax? That’s great! Whether you are a frequent open source contributor or are new to the open source world, you are welcome to contribute to the Pinax project. If you’ve never contributed to open source before, we’d be proud if your very first open source contribution would be for the Pinax project.

There are many ways you can help contribute to the various apps, themes, and starter projects that Pinax is made up of. Contributing code, writing documentation, reporting bugs, as well as reading and providing feedback on issues and pull requests, are all valid and necessary ways to help.

Contributing code

Do you have an idea for a new app, theme, or starter project, or want to improve an existing one? We’d love for you to contribute your idea. This contributor’s guide provides some guidelines for you on how to contribute code to the Pinax project. Don’t worry about breaking the rules, or making mistakes. We’re here to help! If you have questions or run into any issues, please tweet us at @pinaxproject or join our Pinax Slack channel.

Writing documentation

You can find the existing Pinax documentation here. Our docs live in this GitHub repository. There are still quite a few parts of Pinax which are undocumented. If you enjoy writing documentation, please help us extend our existing documentation and making user experience better. Have you worked with a Pinax app or starter project that documentation is missing for? Document your work and how you used the product! Did you build a cool website with Pinax? Write a tutorial about it and help other users get started building websites with Pinax as well. If you find any mistakes in the existing documentation, or have an idea on how to improve it, please let us know by creating an issue or pull request.

Reporting bugs

If you find any bugs while working with Pinax, it would be great if you would let us know. You can either report a bug by creating an issue on GitHub or fix the bug yourself and create a pull request. You can find the different repositories for our Pinax apps, themes, and starter projects here.

Reading and providing feedback on issues and pull requests

If you find any issues or pull requests on our Pinax GitHub website, please feel free to read and review them, and provide feedback. Please remember to be respectful and friendly when commenting on issues or pull requests. It’s okay for people to make mistakes and ask questions. See our Code of Conduct for reference.

We look forward to seeing your Pinax contributions and to working with you!