Skip to main content

Welcome to Nebari!

Thanks for being interested in contributing to Nebari. We're glad you want to join this community! Open source doesn't always have the best reputation for being friendly and welcoming. The Nebari team believes that everyone belongs in open source, and Nebari is dedicated to making you feel welcome.

All contributions are welcome, including issues, contributing code, new docs as well as updates and tweaks, blog posts, helping out people, organizing community events, working on accessibility and design items, and more. Continue reading to learn what the community can do for you and what you can do for the community. By contributing to open source projects, you can connect with people, learn new skills, become a subject-matter expert, and apply all learnings to your projects.

Resources​

Code of conduct​

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Read the Nebari Code of Conduct.

Getting support​

  • GitHub Discussions serve as our user forum. You can use them to raise discussions about a subject, such as: "What is the recommended way to do X with Nebari?"

  • The Nebari issue tracker is the preferred channel for bug reports, documentation requests, and submitting pull requests.

How to contribute​

We want to make the contributing experience within Nebari fun, enjoyable, and educational for anyone and everyone. Contributions go far beyond pull requests and commits if you're interested in participating in the Nebari community.

There are many ways in which you can help Nebari (they're all important, so we list them in alphabetical order):

  1. Code maintenance and development
  2. Community coordination and contributor experience
  3. DevOps
  4. Fundraising
  5. Marketing
  6. Project management
  7. Content translation and internationalization
  8. Website design and development
  9. Writing technical documentation
  10. UI/UX
  11. Opening issues and reviewing Pull Requests

Help fellow users​

Answering questions for fellow Nebari users on GitHub Discussions are valuable contributions. You can also help users on issues and Pull Requests to contribute or fix their issues.

Contribute documentation​

You can help make the docs awesome. We strive to create inclusive, comprehensive, and enjoyable documentation for our users and everyone can help! Found a typo or an incorrect code example? Put up a PR! Found a better way to explain a concept? Put up a PR! Contributions to our documentation are valuable and greatly appreciated.

Contribute code​

Help triage issues​

Triaging an issue means gathering missing information, running the given reproduction, verifying the issue's validity, and investigating the root cause of the problem. You don't have to triage an issue with the goal of fixing it (although it would undoubtedly be much appreciated), but sharing your investigation results can save us a ton of time.

Acknowledgements​

Our contributing and community guidelines take inspiration from the following projects: