|
|
| (15 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| {{DISPLAYTITLE:NixOS Contributor's Guide}}
| | 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 [https://github.com/NixOS/nixpkgs Nixpkgs], the package repository for the [https://nixos.org/ 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 [https://nixos.org/manual/nixpkgs/stable/ Nixpkgs manual] provides detailed documentation on how packages are defined and managed. It's essential to understand concepts like:
| |
|
| |
|
| * Package derivations
| | == Contributing to Nixpkgs == |
| * Nix expression language
| | 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. |
| * Nixpkgs architecture
| |
|
| |
|
| ==== '''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] |
| To start contributing to Nixpkgs, ensure your development environment is properly configured:
| | * Guide on [https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md Contributing to Nixpkgs] in general |
|
| |
|
| * '''Install Nix''': [https://nixos.org/download.html Install Nix] on your local machine if you haven't already. This allows you to build packages and test changes locally.
| | == Contributing to the documentation == |
| * '''Clone the Repository''': Fork and clone the Nixpkgs repository from GitHub.
| | 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]. |
| | |
| ==== '''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 [https://github.com/NixOS/nixpkgs/issues Nixpkgs issue tracker] on GitHub to find open issues, package requests, or ongoing discussions. Look for issues tagged as "good first issue", "help wanted", or "packaging request" to get started.
| |
| * '''Check Outdated Packages''': Use tools like [https://github.com/Mic92/nixpkgs-review nixpkgs-review] to identify outdated packages that need updating.
| |
| | |
| ==== '''1.4 Contributing Code''' ====
| |
| Once you've identified an issue or package to work on, you can start contributing code:
| |
| | |
| * '''Branch''': Create a new branch for your changes using a descriptive name.
| |
| * '''Make Changes''': Implement the necessary changes to the package definition. Ensure your changes adhere to the [https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#conventions Nixpkgs packaging guidelines] and maintain consistency with existing code.
| |
| * '''Testing''': Test your changes locally using <code>nix-build</code> to verify functionality and compatibility with other packages. Include appropriate tests if required by the package's guidelines or to validate new functionality.
| |
| * '''Documentation''': Update relevant documentation, including the package's meta attributes and any necessary usage instructions.
| |
| | |
| ==== '''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.
| | See [https://nix.dev/contributing/documentation Contributing Documentation] for how you can help. |
| * '''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 using the provided PR template. Reference any relevant issues or discussions to facilitate review and feedback.
| |
| * '''CI Checks''': Ensure your PR passes all continuous integration checks. Address any failures promptly.
| |
| | |
| ==== '''1.6 Collaboration and Feedback''' ====
| |
| Collaborate with the Nixpkgs community and address feedback on your PR:
| |
| | |
| * '''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.
| |
| * '''Be Patient''': The review process may take time due to the high volume of contributions. Stay engaged and be prepared to make updates as needed.
| |
| | |
| ==== '''1.7 (Bonus) Continuous Learning and Improvement''' ====
| |
| Contributing to Nixpkgs is an ongoing learning process:
| |
| | |
| * '''Stay Updated''': Keep up with changes in Nixpkgs by following the [https://weekly.nixos.org/ NixOS weekly newsletter] and joining community channels on platforms like [https://matrix.to/#/#nixos:matrix.org Matrix] or [https://discord.gg/RbvHtGa Discord].
| |
| * '''Attend Community Events''': Participate in [https://nixcon.org/ NixCon] and other community events to network and learn from experienced contributors.
| |
| * '''Explore Advanced Topics''': Dive into advanced Nix topics like [https://nixos.wiki/wiki/Flakes flakes] and [https://nixos.wiki/wiki/Overlays overlays] to enhance your contributions.
| |
| | |
| ==== 1.8 (Bonus) Alternative Contribution Methods ====
| |
| | |
| * '''Mailing List''': Submit patches via the [https://lists.nixos.org/mailman/listinfo/nix-devel Nixpkgs mailing list] if you prefer email-based contributions.
| |
| * '''Nix User Repositories (NUR)''': Consider creating your own [https://github.com/nix-community/NUR NUR] to share packages that may not fit within Nixpkgs. This can be an excellent way to experiment and receive community feedback.
| |
| | |
| ==== 1.9 Conclusion ====
| |
| Contributing to Nixpkgs offers an opportunity to impact a widely-used package repository and collaborate with a diverse community of developers and users. By following best practices, actively engaging with the community, and continuously learning, you can make meaningful contributions to the Nix ecosystem and help shape the future of declarative package management.
| |
| | |
| For more detailed information, refer to the official [https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md Contributing to nixpkgs] guide in the Nixpkgs manual.
| |
|
| |
|
| == 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 ==== | | === Contributing to the content === |
| Before you start contributing, familiarize yourself with the structure and purpose of the NixOS Wiki:
| |
|
| |
|
| * '''Explore the Wiki:''' Visit this Wiki's main categories to understand its organization and the types of content it hosts. The wiki covers installation guides, configuration tips, package management, and more. | | * Read and adhere the NixOS [[Manual of Style]] to ensure consistency across the wiki. |
| * '''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. | | * 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. |
| | * Join the relevant [[MatrixRooms|Matrix room]] |
|
| |
|
| ==== 2.2 Contributing Content ==== | | === Contributing to the infrastructure === |
| 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.
| | 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. |
| * '''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 in the community forums.
| |
| * '''Understand the Wiki Structure:''' Familiarize yourself with the wiki's category system to ensure your contributions are properly organized and easily discoverable.
| |
|
| |
|
| ==== 2.3 Writing and Editing Wiki Pages ====
| |
| Follow these guidelines when writing or editing content on the NixOS Wiki:
| |
|
| |
| * '''Learn the syntax:''' The NixOS Wiki uses MediaWiki markup. Familiarize yourself with this syntax to format your contributions effectively.
| |
| * '''Provide Context and Examples:''' Ensure content is clear and understandable. Include examples and practical advice to help users implement solutions effectively. When possible, provide both simple and advanced examples to cater to users of different skill levels.
| |
| * '''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.
| |
| * '''Use Templates:''' Use existing wiki templates to maintain consistency across pages and provide standardized information.
| |
|
| |
| ==== 2.4 Submitting Edits ====
| |
| 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.
| |
| * '''Document Changes:''' Write a concise summary of your edits in the edit summary box. This informs other contributors about the purpose of your changes and helps maintain a clear edit history.
| |
| * '''Follow the Style Guide:''' Adhere to the NixOS Wiki Style Guide to ensure consistency across the wiki.
| |
|
| |
| ==== 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 discussion 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 Advanced Contributions ====
| |
| For those looking to make more significant contributions:
| |
|
| |
| * '''Create New Sections:''' Identify and propose new sections or categories that could benefit the wiki's structure and organization.
| |
| * '''Translate Content:''' Help make the NixOS Wiki more accessible by contributing translations to other languages.
| |
| * '''Develop Wiki Tools:''' If you have programming skills, consider contributing to tools that can help maintain and improve the wiki, such as bots for automated tasks or extensions to enhance wiki functionality.
| |
|
| |
| ==== 2.7 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.
| |
|
| |
| Remember that the NixOS Wiki is a living document, continuously evolving with the NixOS ecosystem. Your contributions, no matter how small, are valuable in keeping this resource up-to-date and helpful for users worldwide.
| |
|
| |
| == 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]].
| |
| [[Category:Development]] | | [[Category:Development]] |
| [[Category:Contributions]] | | [[Category:Contributions]] |
| | |
| {{DEFAULTSORT:NixOS Contributor's Guide.}} | | {{DEFAULTSORT:NixOS Contributor's Guide.}} |
| {{DEFAULTSORT:NixOS Contributor's Guide}}
| |
