From d410dc0c360055ae679d6efe444c997bd488898b Mon Sep 17 00:00:00 2001 From: Gaius Date: Thu, 9 Jul 2026 20:47:44 +0800 Subject: [PATCH] docs: reformat CONTRIBUTING.md for better line length readability MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Wraps long prose lines throughout CONTRIBUTING.md to improve readability in plain-text editors and terminal views. No content changes — only line breaks added. Signed-off-by: Gaius --- CONTRIBUTING.md | 76 +++++++++++++++++++++++++++++++++++-------------- 1 file changed, 54 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2fd2e5a..7a4f107 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ # Contributing to Dragonfly -We're thrilled that you're interested in hacking on Dragonfly! We welcome and encourage all contributions. Here’s a guide to help you get started. +We're thrilled that you're interested in hacking on Dragonfly! We welcome and encourage all contributions. +Here’s a guide to help you get started. ## Topics @@ -12,15 +13,24 @@ We're thrilled that you're interested in hacking on Dragonfly! We welcome and en ## Reporting Security Issues -We take security very seriously. To protect our community, we ask that you don't disclose security vulnerabilities publicly. If you discover a security issue in Dragonfly, please don't open a public issue or discuss it in public forums. Instead, send us a private email at [dragonfly-maintainers@googlegroups.com](mailto:dragonfly-maintainers@googlegroups.com) to report it. +We take security very seriously. To protect our community, we ask that you don't disclose security +vulnerabilities publicly. If you discover a security issue in Dragonfly, please don't open a +public issue or discuss it in public forums. Instead, send us a private email +at [dragonfly-maintainers@googlegroups.com](mailto:dragonfly-maintainers@googlegroups.com) to report it. ## Reporting General Issues -We consider every Dragonfly user a valuable contributor. After trying out Dragonfly, you might have some feedback for us. Feel free to open an issue on GitHub by clicking [NEW ISSUE](https://github.com/dragonflyoss/dragonfly/issues/new). +We consider every Dragonfly user a valuable contributor. After trying out Dragonfly, you might +have some feedback for us. Feel free to open an issue on GitHub by clicking [NEW ISSUE](https://github.com/dragonflyoss/dragonfly/issues/new). -Because we're a distributed team, we really appreciate **well-written**, **detailed**, and **clear** issue reports. To keep our communication efficient, please search existing issues to see if your problem has already been reported. If it has, please add your comments to the existing issue instead of creating a new one. +Because we're a distributed team, we really appreciate **well-written**, **detailed**, and +**clear** issue reports. To keep our communication efficient, please search existing issues to +see if your problem has already been reported. If it has, please add your comments to the existing +issue instead of creating a new one. -To help standardize our issue reports, we've created an [ISSUE TEMPLATE](./.github/ISSUE_TEMPLATE) with options for questions, bug reports, and feature requests. Please be sure to follow the template and fill in all the required fields. +To help standardize our issue reports, we've created an [ISSUE TEMPLATE](./.github/ISSUE_TEMPLATE) with +options for questions, bug reports, and feature requests. Please be sure to follow the template and fill +in all the required fields. You can open an issue for many reasons, including: @@ -34,7 +44,8 @@ You can open an issue for many reasons, including: - Test improvements - Any questions about the project -Also, a friendly reminder: when you file a new issue, please make sure to remove any sensitive data from your post. This includes things like passwords, secret keys, network locations, and private business information. +Also, a friendly reminder: when you file a new issue, please make sure to remove any sensitive data from your post. +This includes things like passwords, secret keys, network locations, and private business information. ## Contributing Code and Docs @@ -70,11 +81,14 @@ To submit a PR, you'll need a GitHub account. Once you have one, follow these st 1. **FORK** Dragonfly to your own repository. - To do this, just click the "Fork" button in the top-right corner of the [dragonflyoss/dragonfly](https://github.com/dragonflyoss/dragonfly) main page. This will create a copy of the repository under your own account at `https://github.com//dragonfly`. + To do this, just click the "Fork" button in the top-right corner + of the [dragonflyoss/dragonfly](https://github.com/dragonflyoss/dragonfly) main page. This will + create a copy of the repository under your own account at `https://github.com//dragonfly`. 2. **CLONE** your forked repository to your local machine. - Use `git clone --recurse-submodules https://github.com//dragonfly.git` to clone the repository locally. Now you can create new branches and make your changes. + Use `git clone --recurse-submodules https://github.com//dragonfly.git` to clone the repository + locally. Now you can create new branches and make your changes. 3. **Set the remote upstream** to `https://github.com/dragonflyoss/dragonfly.git`. @@ -118,15 +132,21 @@ To submit a PR, you'll need a GitHub account. Once you have one, follow these st ### Branching Strategy -For now, we assume all contributions made via pull requests are intended for the `main` branch of Dragonfly. Understanding our branching strategy will help you contribute more effectively. +For now, we assume all contributions made via pull requests are intended for the `main` branch of Dragonfly. +Understanding our branching strategy will help you contribute more effectively. -As a contributor, please remember that all pull requests should target the `main` branch. However, the Dragonfly project also uses other types of branches, such as release candidate (rc) branches, release branches, and backport branches. +As a contributor, please remember that all pull requests should target the `main` branch. However, the +Dragonfly project also uses other types of branches, such as release candidate (rc) branches, release +branches, and backport branches. -Before a new version is officially released, we create a release candidate (rc) branch. This branch undergoes more rigorous testing than the `main` branch. +Before a new version is officially released, we create a release candidate (rc) branch. This branch undergoes +more rigorous testing than the `main` branch. -When we're ready to release a new version, we create a release branch just before tagging. After the version is tagged, we delete the release branch. +When we're ready to release a new version, we create a release branch just before tagging. After the version +is tagged, we delete the release branch. -When we need to backport fixes to an existing released version, we create backport branches. These backported changes will be reflected in the PATCH number of our [SemVer](http://semver.org/) versioning (MAJOR.MINOR.PATCH). +When we need to backport fixes to an existing released version, we create backport branches. These backported +changes will be reflected in the PATCH number of our [SemVer](http://semver.org/) versioning (MAJOR.MINOR.PATCH). ### Commit Rules @@ -137,7 +157,9 @@ In Dragonfly, we take two rules very seriously when it comes to commits: #### Commit Message -A clear commit message helps reviewers understand the purpose of your PR and speeds up the code review process. We encourage you to use **explicit** and descriptive commit messages. We follow a conventional commit format: +A clear commit message helps reviewers understand the purpose of your PR and speeds up the code review +process. We encourage you to use **explicit** and descriptive commit messages. We follow a conventional +commit format: - `feat`: A new feature (e.g., "feat: add support for sorted results"). - `fix`: A bug fix (e.g., "fix: prevent panic when input is nil"). @@ -155,7 +177,8 @@ On the other hand, we discourage ambiguous commit messages like: #### Commit Content -The content of a commit should include all the changes necessary for a complete and reviewable unit of work. Ideally, a single commit should be self-contained and pass CI on its own. Here are two simple rules to keep in mind: +The content of a commit should include all the changes necessary for a complete and reviewable unit of work. +Ideally, a single commit should be self-contained and pass CI on its own. Here are two simple rules to keep in mind: - Avoid making very large changes in a single commit. - Ensure each commit is complete and can be reviewed independently. @@ -164,22 +187,27 @@ No matter the commit message or content, we place a strong emphasis on thorough ### PR Description -A Pull Request (PR) is the only way to make changes to the Dragonfly project files. To help reviewers understand your contribution, please provide a detailed PR description. We encourage you to follow our [PR template](./.github/PULL_REQUEST_TEMPLATE.md) when creating your pull request. +A Pull Request (PR) is the only way to make changes to the Dragonfly project files. To help reviewers understand your +contribution, please provide a detailed PR description. We encourage you to follow +our [PR template](./.github/PULL_REQUEST_TEMPLATE.md) when creating your pull request. ### Development Environment -To ensure a smooth development process, all contributors should use the same versions of our development tools. Here are the dependencies and their required versions: +To ensure a smooth development process, all contributors should use the same versions of our development tools. +Here are the dependencies and their required versions: - **Go**: Check the `go.mod` file for the required version. - **misspell**: latest - **shellCheck**: latest - **Docker**: latest -When developing locally, you can use the subcommands in our `Makefile` to build and check your code. We use Docker to build Dragonfly, which helps minimize environment-related issues. +When developing locally, you can use the subcommands in our `Makefile` to build and check your code. We use Docker to +build Dragonfly, which helps minimize environment-related issues. ### Go Dependency Management -The Dragonfly project uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage external packages. You can find the required dependency versions in the `go.mod` file. +The Dragonfly project uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to +manage external packages. You can find the required dependency versions in the `go.mod` file. To add or update a dependency, use the `go get` command: @@ -201,12 +229,16 @@ You'll need to commit the changes to `go.mod` and `go.sum` before submitting you ## Getting Involved -There are many ways to get involved and help the Dragonfly community. Whether you're a developer, a user, or just an enthusiast, we'd love to have you! +There are many ways to get involved and help the Dragonfly community. Whether you're a developer, a user, or just +an enthusiast, we'd love to have you! - **Join the discussion**: Participate in our community channels, ask questions, and share your ideas. - **Help others**: Answer questions from other users and help them get started with Dragonfly. -- **Spread the word**: Tell your friends and colleagues about Dragonfly, write a blog post, or share your experience on social media. +- **Spread the word**: Tell your friends and colleagues about Dragonfly, write a blog post, or share your experience + on social media. ## Becoming a Dragonfly Member -If you're a regular contributor and want to take on a more formal role in the community, you can become a Dragonfly Member. Members have additional privileges and responsibilities, and they play a key role in shaping the future of the project. To learn more about becoming a member, check out our [Contributor Ladder](COMMUNITY_LADDER.md). +If you're a regular contributor and want to take on a more formal role in the community, you can become a +Dragonfly Member. Members have additional privileges and responsibilities, and they play a key role in +shaping the future of the project. To learn more about becoming a member, check out our [Contributor Ladder](COMMUNITY_LADDER.md).