Contributing¶
First off, thank you for landing here and considering contributing to NightPOS!
This documentation serves as a guide for first-timer and veteran contributors. As an open-core project, NightPOS accepts contributions from everyone, NightPOS employees and members of the NightPOS community alike. The NightPOS community comprises users, developers, and other interested parties who contribute their time and expertise.
Depending on your skill set and interest, there are many ways to contribute to NightPOS. The table below lists the most important of them.
Contribution |
Description |
Resources |
Target Audience |
|---|---|---|---|
Join the community |
Participate in discussions on the forums, help answer questions, and assist other members of the NightPOS community. |
Anyone interested in NightPOS |
|
Submit bug reports |
Help improve the stability of NightPOS by reporting the bugs that you discover in supported versions directly to NightPOS support. Make sure to include as many details (version, environment, test scenario…) as possible. If you don’t have the NightPOS Enterprise license required for contacting the support, open a new issue on the GitHub repository of NightPOS. |
Users of NightPOS |
|
Translate NightPOS |
Translate the user interface and documentation of NightPOS into different languages. |
Anyone fluent in multiple languages |
|
Contribute to the codebase |
Submit pull requests to the NightPOS GitHub repositories to fix bugs, add new features, or improve the performance and reliability of the product. You can also review and comment on pull requests from other contributors. By contributing to the codebase, you can make a direct and lasting impact on the quality and features of NightPOS. |
Developers with experience in Python and web development |
|
Contribute to the documentation |
Submit corrections and improvements to the NightPOS documentation. The product evolves fast, and it can be challenging to consistently reflect these changes in the documentation. By updating the documentation, you can help many users find their way in NightPOS. |
Anyone interested in improving the NightPOS documentation |
|
Create custom modules |
Develop new modules to extend the functionality of NightPOS. Custom modules can be made available for free or paid on the NightPOS App Store or on any other NightPOS modules library. By creating custom modules and making them available to others, you can help grow the NightPOS ecosystem and provide additional value to users of the platform. |
Developers with experience in Python and web development |
Important
It is mainly NightPOS employees who develop new features for the codebase and write new content for the documentation. Be sure to discuss any idea for a new feature or page with the NightPOS team so they can give you the green light before you begin working on it. Some features may already be in development on their side, and only approved features can be merged.