Contributing to cloudgeass

The cloudgeass python package were bring to life from personal experiences and tasks that the author personally faced in his professional and personal journey.

Suddenly, the functions and methods that had been built turned into something really useful not only for the author's purpose, but for everyone else that were facing the same challenges. And now cloudgeass is something that everyone can use, share and contribute.

Ho can I contribute to the package?

First, it's important to check if your idea or code block has not been previously written in the library as a function or class method.

After that, if your think your contribution is relevant within the package purposes, feel free to open a new pull request.

• Source GitHub repository
• PyPI package page

Issues

Pointing out an issue is also a way to contribute! We built a series of issue templates that you can use to open an issue on cloudgeass source repo. Currently, we have the following templates available:

• 🐞 Bug report to report errors or bugs
• 📄 Documentation to report opportunities and improvements on docs
• 🚀 Feature request to request a new feature (function, class, method or anything else)
• 😵‍💫 Help needed to ask for help
• 🤔 Question for general questions about the library

Some good practices

Finally, there are some recommendations that can improve your experience on contributing to this or any other project:

• GitHub semantic commit messages
• Conventional commits
• Semantic versioning