Welcome to Nebari!
Thanks for being part of the Nebari 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 questions and contributions are welcome. Contributions can include 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. We look forward to hearing from you!
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. The following Code of Conduct applies to all spaces in the Nebari community, from GitHub to video meetings.
- GitHub Discussions serve as our user forum. You can use them to ask questions or 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.
All the Nebari logo marks, fonts, and colors are stored and documented in the
nebari-design GitHub repository.
Documents that define the Nebari GitHub organization and team wide workflows, decision making policies, project roadmap, and more are hosted in a separate repository
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):
- Code maintenance and development
- Community coordination and contributor experience
- Project management
- Content translation and internationalization
- Website design and development
- Writing technical documentation
- Opening issues and reviewing pull requests
Help fellow users
The Nebari repo consists of many interconnected pieces, making it difficult to start contributing. To learn how to set up the repository locally, how to contribute to the project, and how to create a pull request:
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.
To learn more about our style guide, the documentation structure, and how to write docs:
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.
We have a:
- bi-weekly 1-hour community meeting to chat about everything Nebari, and
- weekly 30-minute triage meeting where we triage and follow-up on open issues and PRs.
The embedded Google Calendar below shows the meeting schedules. Click on the meeting event in the calendar to find more details like the Google Meet link, or to copy the event to your personal calendar.
Guidelines and processes for maintaining the Nebari project are documented in the following documents:
Our contributing and community guidelines take inspiration from the following projects: