Thank you for showing interest in pottery! We'll love you have you on board. We hope you can enjoy building pottery as much as we do. First of all, please, read our Code Of Conduct. It is important, as we want to build a community where everyone feels safe, so following the Code Of Conduct is a must.
Second, if you are interested, take a look at our License. As a summary, your code is going to be Open Source, you can use pottery as you want, but please, keep it Open Source.
Third and lastly, if you are interested in security, read of Security guidelines to know more.
There are different ways to contribute to pottery, you can do whatever it suits best to your time and commitment.
- You can use pottery and provide feedback. That already helps a lot improving the tool.
- Also, share the project! If you like it, share honest feedback with the community: Pottery is clearly not perfect, but it can suit other people needs, and feedback is always useful.
- You can design new features. Create a new Feature Request and have fun. To be clear, sharing new feature ideas do not mean that we are going to build them as is, or even building them at all. However, feedback will be shared and reasons provided either way.
- If you are more on the coding side, you can fix issues marked as
good first issue. Feel free to take bug reports or feature requests that are not marked aswon't do. - You can provide bug reports. Create a new Bug Report and help the product be faster, more stable and more useful!
- You can also share Security issues within pottery by creating a Security Issue bug report.
- Writing down new documentation is also a wonderful way to start contributing. Documentation is a jekyll server in this repository, so just download it and play with the documentation.