|
|
| (19 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| {{warning|This page is currently undergoing heavy changes. I will remove this warning after everything is completed.}}
| | It is possible to contribute to Nix(OS) in different ways: |
| | * Contributing to Nix |
| | * Contributing to the documentation |
| | * [[Contributing#Contributing to the Official NixOS Wiki|Contributing to the Official NixOS Wiki]] (see below) |
| | * [[Contributing#Contributing to Nixpkgs|Contributing to Nixpkgs]] (see below) |
|
| |
|
| == Contributing to Nixpkgs == | | == Contributing to Nix == |
| Contributing to Nixpkgs, the package repository for the Nix package manager, allows you to help maintain and improve the ecosystem of software available to Nix users. This guide outlines steps to get started with contributing to Nixpkgs effectively.
| |
|
| |
|
| '''1.1 Getting Started'''
| | See the [https://github.com/NixOS/nix/blob/master/CONTRIBUTING.md Nix repository contribution guide]. |
|
| |
|
| Before you begin, familiarize yourself with how Nixpkgs is structured. The Nixpkgs manual provides detailed documentation on how packages are defined and managed.
| | == Contributing to Nixpkgs == |
| | Contributing to [https://github.com/NixOS/nixpkgs Nixpkgs], the package repository for the [https://nixos.org/ Nix package manager], helps maintain and improve the ecosystem of software available to Nix users. |
|
| |
|
| '''1.2 Setting Up Your Development Environment'''
| | * Guide on [https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md Contributing to the packages in Nixpkgs] |
| | * Guide on [https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md Contributing to Nixpkgs] in general |
|
| |
|
| To start contributing to Nixpkgs, ensure your development environment is properly configured:
| | == Contributing to the documentation == |
| | | Reference documentation and learning materials for using Nix standalone are maintained on [https://nix.dev/ nix.dev] by the [https://github.com/nixos/nix.dev/tree/master/maintainers Nix documentation team]. |
| * Install Nix: Install Nix on your local machine if you haven't already. This allows you to build packages and test changes locally.
| |
| * Clone the Repository: Fork and clone the Nixpkgs repository from GitHub.
| |
| | |
| '''1.3 Finding an Issue or Package to Work On'''
| |
| | |
| Contributions often begin by identifying an issue to address or a package to update within Nixpkgs:
| |
| | |
| * Explore the Issue Tracker: Visit the Nixpkgs issue tracker on GitHub to find open issues, package requests, or ongoing discussions. Look for issues tagged as "Packaging request" or "Build failure" to get started.
| |
| | |
| '''1.4 Contributing Code'''
| |
| | |
| Once you've identified an issue or package to work on, you can start contributing code:
| |
| | |
| * Fork and Branch: Fork the Nixpkgs repository on GitHub and create a new branch for your changes.
| |
| * Make Changes: Implement the necessary changes to the package definition or address the issue using the Nix expression language. Ensure your changes adhere to the Nixpkgs packaging guidelines and maintain consistency with existing code.
| |
| * Testing: Test your changes locally to verify functionality and compatibility with other packages. Include appropriate tests if required by the package's guidelines or to validate new functionality.
| |
| | |
| '''1.5 Submitting a Pull Request (PR)'''
| |
| | |
| When your changes are ready, submit a pull request to the Nixpkgs repository for review:
| |
| | |
| * Push Changes: Push your branch to your forked repository.
| |
| * Create a PR: Navigate to the Nixpkgs repository on GitHub, select your branch, and create a pull request. Provide a clear title and detailed description of your changes. Reference any relevant issues or discussions to facilitate review and feedback.
| |
| | |
| '''1.6 Collaboration and Feedback'''
| |
|
| |
|
| Collaborate with the Nixpkgs community and address feedback on your PR:
| | See [https://nix.dev/contributing/documentation Contributing Documentation] for how you can help. |
| | |
| * Review and Iterate: Respond promptly to comments and suggestions from maintainers and contributors. Make necessary revisions to your code to address any requested changes or improvements.
| |
| * Engage in Discussions: Participate in discussions related to your contribution and other ongoing developments within Nixpkgs. Contributing isn't just about code; sharing insights and knowledge can enrich the community.
| |
| | |
| '''1.7 Conclusion'''
| |
| | |
| Contributing to Nixpkgs offers an opportunity to contribute to a widely-used package repository and collaborate with a diverse community of developers and users. By following best practices and actively engaging with the community, you can make meaningful contributions to the Nix ecosystem.
| |
| | |
| See also [[Contributing to nixpkgs]]. | |
| | |
| There is also a [[nixpkgs-dev-ml|Maillinglist]] where you can submit patches if you prefer to submit patches via email. These will then be forwarded to [[Nixpkgs]] as a pull request by someone on the mailing list.
| |
| | |
| ==== 1.8 Alternative: Contribute to Nix User Repositories ====
| |
| In case your package(s) don't fit within nixpkgs, you may consider creating your own [[Nix User Repository]] (NUR) to share your work with others. This cuts down on maintenance costs among community members, and gives you a way to receive feedback from others.
| |
|
| |
|
| == Contributing to the Official NixOS Wiki == | | == Contributing to the Official NixOS Wiki == |
| Contributing to the official NixOS Wiki is an invaluable way to improve documentation, share knowledge, and support users in navigating the NixOS ecosystem. This guide provides clear steps to help you begin contributing effectively to the NixOS Wiki.
| |
|
| |
| ==== 2.1 Getting Started ====
| |
| Before you start contributing, familiarize yourself with the structure and purpose of the NixOS Wiki:
| |
|
| |
| * '''Explore the Wiki:''' Visit the NixOS Wiki to understand its organization and the types of content it hosts. The wiki covers installation guides, configuration tips, package management, and more.
| |
| * '''Engage with the Community:''' Join discussions on platforms like the [https://github.com/NixOS/nixos-wiki-infra GitHub Wiki Repository]. Active participation can highlight areas where documentation needs improvement.
| |
|
| |
| ==== 2.2 Contributing Content ====
| |
| Contributions to the NixOS Wiki involve creating new pages or editing existing ones to improve clarity and relevance:
| |
|
| |
| * '''Create a Wiki Account:''' Register an account on the NixOS Wiki to start contributing. This allows you to create and edit pages directly.
| |
| * '''Identify Areas for Improvement:''' Review current wiki pages to find gaps or areas that could benefit from more detailed explanations. Focus on topics that are frequently discussed or updated.
| |
|
| |
|
| ==== 2.3 Writing and Editing Wiki Pages ==== | | === Contributing to the content === |
| Follow these guidelines when writing or editing content on the NixOS Wiki:
| |
|
| |
|
| * '''Learn the syntax:''' ... | | * Read and adhere the NixOS [[Manual of Style]] to ensure consistency across the wiki. |
| * '''Provide Context and Examples:''' Ensure content is clear and understandable. Include examples and practical advice to help users implement solutions effectively. | | * Consider browsing the [https://wiki.nixos.org/wiki/Special:SpecialPages Special Pages] directory which contains useful links for understanding the Wiki's structure and for finding things to improve or create. |
| * '''Linking:''' Use internal wiki links to connect related pages and external links to reputable sources for further reading. This helps users navigate through related topics seamlessly. Add them to the "References" category too.
| | * Join the relevant [[MatrixRooms|Matrix room]] |
|
| |
|
| ==== 2.4 Submitting Edits ==== | | === Contributing to the infrastructure === |
| Once you've prepared your contributions, submit them to the NixOS Wiki:
| |
|
| |
|
| * '''Save Page:''' Use the wiki's editing interface to save the changes directly. Preview your edits to ensure they appear as intended before saving.
| | The configuration is hosted on [https://github.com/NixOS/nixos-wiki-infra/ GitHub]. Discussions take place there, as well as in the [[MatrixRooms|Matrix room]], and during the documentation team meetings, which are public. |
| * '''Document Changes:''' Write a concise summary of your edits in the edit summary box. This informs other contributors about the purpose of your changes.
| |
|
| |
|
| ==== 2.5 Engaging in Discussions ====
| |
| Stay connected with the NixOS Wiki community to foster collaboration and knowledge sharing:
| |
|
| |
| * '''Discuss Changes:''' Participate in discussions on the wiki's talk pages or relevant community forums. Solicit feedback on proposed changes to refine content and ensure accuracy.
| |
| * '''Review and Update:''' Regularly review existing wiki pages to keep information current. Update content based on new features, community feedback, or changes in the NixOS environment.
| |
|
| |
| ==== 2.6 Conclusion ====
| |
| Contributing to the official NixOS Wiki allows you to improve the community's knowledge base and support users in adopting and maintaining NixOS effectively. By adhering to these guidelines and actively engaging with the community, you play a vital role in improving the accessibility and comprehensiveness of NixOS documentation.
| |
|
| |
| == Contributing to Nix ==
| |
|
| |
| See the [https://github.com/NixOS/nix/blob/master/CONTRIBUTING.md Nix repository contribution guide].
| |
|
| |
| == Contributing to the documentation ==
| |
|
| |
| See [[Contributing to Nix documentation]].
| |
|
| |
| == Support other users ==
| |
|
| |
| Nix/NixOS is a community-led effort. It is up to every participant to help each other learn and use Nix effectively. Here are some ways to help other users:
| |
|
| |
| * Help users on the [https://discourse.nixos.org/ Nix Discourse].
| |
| * Help users on the Nix Matrix (real time chat). Consider joining a [[MatrixRooms|Matrix room]] that matches your interest/expertise.
| |
| * Write blog posts on how to do things with Nix(OS).
| |
| * Engage with others on social media about Nix(OS).
| |
| [[Category:Development]] | | [[Category:Development]] |
| [[Category:Contributions]] | | [[Category:Contributions]] |
| | |
| | {{DEFAULTSORT:NixOS Contributor's Guide.}} |
It is possible to contribute to Nix(OS) in different ways:
Contributing to Nix
See the Nix repository contribution guide.
Contributing to Nixpkgs
Contributing to Nixpkgs, the package repository for the Nix package manager, helps maintain and improve the ecosystem of software available to Nix users.
Contributing to the documentation
Reference documentation and learning materials for using Nix standalone are maintained on nix.dev by the Nix documentation team.
See Contributing Documentation for how you can help.
Contributing to the Official NixOS Wiki
Contributing to the content
- Read and adhere the NixOS Manual of Style to ensure consistency across the wiki.
- Consider browsing the Special Pages directory which contains useful links for understanding the Wiki's structure and for finding things to improve or create.
- Join the relevant Matrix room
Contributing to the infrastructure
The configuration is hosted on GitHub. Discussions take place there, as well as in the Matrix room, and during the documentation team meetings, which are public.
