Skip to content

Nixopus Contribution Guidelines

Welcome to the Nixopus Contribution Guidelines. This page serves as an index to our specialized contribution guides. We value and appreciate all contributions to the project, whether they're bug fixes, feature additions, documentation improvements, or any other enhancements.

Choose Your Contribution Area

Each specialized guide provides detailed instructions for contributing to specific aspects of Nixopus:

Contribution GuideDescriptionKey Topics
General ContributingGeneral contribution workflowBasic setup, making changes, pull request process
Backend DevelopmentGo backend contributionsAPI features, database migrations, testing
Frontend DevelopmentNext.js/React frontendComponent development, Redux integration, UI guidelines
DocumentationDocumentation improvementsMarkdown formatting, content guidelines, API docs
Self-HostingInstallation and self-hostingInstaller improvements, environment support
Docker BuildsContainer optimizationImage optimization, security, orchestration
Development FixturesDevelopment data managementSample data, testing fixtures, data setup

Getting Started

New to contributing? Here's a quick path to making your first contribution:

  1. Choose an area that interests you from the guides above
  2. Set up your development environment following the instructions in the relevant guide
  3. Find an issue to work on - look for issues labeled "good first issue" in our GitHub repository
  4. Implement your changes following the guide's best practices
  5. Submit a pull request with your improvements

Need Help?

If you have questions or need assistance, you can:

Contribution Process Overview

Here's a high-level overview of our contribution process:

Thank you for contributing to Nixopus! Your efforts help make this project better for everyone.

Made with love
Released under the Functional Source License (FSL)