| description |
|---|
Welcome to naas's contributing guide! |
We value contributions of all kinds, not just code. Check out our Community Roadmap for detailed overview of current and future work. We're here to assist you! Feel free to join our Slack community discussion if you have any questions as you progress as a contributor.
Before continuing, please take a moment to read our full Code of Conduct.
- To acquire knowledge and skills
- To find amazing people who share similar interests.
- To advance your career.
- To track down a mentor who can assist you in achieving your goals.
- To be happy! (It truly works)
- Because in addition to every stated above, we want to promote your contributions on social networks to skyrocket your reputation and personal branding
- Because we are also looking for ways to give back more and more to our contributors. Our ultimate goal would be that you could be able to get a revenue stream out of it
- And because it is damn fun to innovate in the notebook space
The following are some areas where one can contribute:
- Templates
- Naas drivers (python package for integrations)
- Naas features (micro-services on top of Jupyter Notebooks)
- Documentation
- Product Management (scoping issues)
- Marketing and communication
The most popular area for contributions is templates because all you need is a notebook and awesome-notebooks to publish your work. Here is a list of simple good first issues available in the templates repository.
Fill out the form (Recommended)
To be recognized as a member of Naas, you must register through this form. Naas membership entitles one to direct contributions and results in a faster review process.
By submitting issues and pull requests to the many GitHub repositories maintained by the Jupyter-Naas organization, you can also independently contribute to the project.
Open an account on naas.ai
It’s free 👉 https://app.naas.ai. For any kind of contribution, having a naas account is more than helpful, it will help you to:
- Test notebooks (for writing content or even doing code review)
- Setup some automation for yourself
- Receive credits thanks to your contributions (WIP)
- Review the latest product update and give feedback.
Take a look at the community roadmap.
Our community roadmap gives insights on the ongoing and upcoming work. Feel free to comment under a good first issue you'd like to work on and we'll assign it to you.\
Be a part of the community and support Naas on social media!
Feel free to drop by to introduce yourself and ask questions on our community calls or over Slack.
We also really appreciate your support on social media (<-see links on the navigation bar). We try to push as much informative, educative, and entertaining but sometimes also provocative content as we can. Because communication comes first, code second.\
Note that at Naas we follow the Conventional Commits specification. It is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top.
In Naas, we use the following commit elements to communicate:
fix:to patch a bugfeat:to introduce a new featuredocs:to document a feature or a fixstyle:to change the UX design of a featurerefactor:to change the way a feature workstest:to add unitary tests to the project
This commit convention applies to Naas and Naas drivers repository.