dragonflyoss
/
dragonfly
mirror of https://github.com/dragonflyoss/dragonfly.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix typos in docs (#1071) 

* docs: fix typos in docs

* docs: update CONTRIBUTING.md
This commit is contained in:
Saksham Sharma 2022-02-16 14:33:52 +05:30 committed by Gaius
parent c6e2c601dc
commit 4a171ac5cb
No known key found for this signature in database
GPG Key ID: 8B4E5D1290FA2FFB
3 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CODE_OF_CONDUCT.md
View File

@ -4,7 +4,7 @@
In the interest of fostering an open and welcoming environment, In the interest of fostering an open and welcoming environment,
we as contributors and maintainers pledge to we as contributors and maintainers pledge to
making participation in our project and make participation in our project and
our community a harassment-free experience for everyone, our community a harassment-free experience for everyone,
regardless of age, body size, regardless of age, body size,
disability, ethnicity, gender identity and expression, disability, ethnicity, gender identity and expression,

42
CONTRIBUTING.md
View File

@ -1,7 +1,7 @@
# Contributing to Dragonfly # Contributing to Dragonfly
It is warmly welcomed if you have interest to hack on Dragonfly. It is warmly welcomed if you have the interest to hack on Dragonfly.
First, we encourage this kind of willing very much. First, we encourage this kind of willingness very much.
And here is a list of contributing guide for you. And here is a list of contributing guide for you.
## Topics ## Topics
@ -18,7 +18,7 @@ Security issues are always treated seriously.
As our usual principle, we discourage anyone to spread security issues. As our usual principle, we discourage anyone to spread security issues.
If you find a security issue of Dragonfly, please do not discuss it in If you find a security issue of Dragonfly, please do not discuss it in
public and even do not open a public issue. public and even do not open a public issue.
Instead we encourage you to send us a private email to Instead, we encourage you to send us a private email to
[Dragonfly@noreply.github.com](mailto:Dragonfly@noreply.github.com) to report this. [Dragonfly@noreply.github.com](mailto:Dragonfly@noreply.github.com) to report this.
## Reporting general issues ## Reporting general issues
@ -41,7 +41,7 @@ You can find three kinds of issue templates there: question,
bug report and feature request. Please **BE SURE** to follow bug report and feature request. Please **BE SURE** to follow
the instructions to fill fields in template. the instructions to fill fields in template.
There are lot of cases when you could open an issue: There are a lot of cases when you could open an issue:
* bug report * bug report
* feature request * feature request
@ -54,7 +54,7 @@ There are lot of cases when you could open an issue:
* any questions on project * any questions on project
* and so on * and so on
Also we must remind that when filing a new issue, Also, we must remind that when filing a new issue,
please remember to remove the sensitive data from your post. please remember to remove the sensitive data from your post.
Sensitive data could be password, secret key, Sensitive data could be password, secret key,
network locations, private business data and so on. network locations, private business data and so on.
@ -76,8 +76,8 @@ via a PR (short for pull request).
* If you find document incorrect, just do it and fix that! * If you find document incorrect, just do it and fix that!
* ... * ...
Actually it is impossible to list them completely. Actually, it is impossible to list them completely.
Just remember one princinple: Just remember one principle:
> WE ARE LOOKING FORWARD TO ANY PR FROM YOU. > WE ARE LOOKING FORWARD TO ANY PR FROM YOU.
@ -177,7 +177,7 @@ MAJOR.MINOR.PATCH of [SemVer](http://semver.org/).
### Commit Rules ### Commit Rules
Actually in Dragonfly, we take two rules serious when committing: Actually in Dragonfly, we take two rules seriously when committing:
* [Commit Message](#commit-message) * [Commit Message](#commit-message)
* [Commit Content](#commit-content) * [Commit Content](#commit-content)
@ -188,7 +188,7 @@ Commit message could help reviewers better understand
what the purpose of submitted PR is. what the purpose of submitted PR is.
It could help accelerate the code review procedure as well. It could help accelerate the code review procedure as well.
We encourage contributors to use **EXPLICIT** commit We encourage contributors to use **EXPLICIT** commit
message rather than ambiguous message. In general, message rather than an ambiguous message. In general,
we advocate the following commit message type: we advocate the following commit message type:
* feat: xxxx.For example, "feat: make result show in sorted order". * feat: xxxx.For example, "feat: make result show in sorted order".
@ -198,10 +198,10 @@ we advocate the following commit message type:
* refactor: xxxx. For example, "refactor: simplify to make codes more readable". * refactor: xxxx. For example, "refactor: simplify to make codes more readable".
* test: xxx. For example, "test: add unit test case for func InsertIntoArray". * test: xxx. For example, "test: add unit test case for func InsertIntoArray".
* chore: xxx. For example, "chore: integrate travis-ci". * chore: xxx. For example, "chore: integrate travis-ci".
It's the type of mantainance change. It's the type of maintenance change.
On the other side, we discourage contributors On the other side, we discourage contributors
from committing message like the following ways: from committing messages in the following ways:
* ~~fix bug~~ * ~~fix bug~~
* ~~update~~ * ~~update~~
@ -237,16 +237,16 @@ Dragonfly project, we should reach an agreement on
the version of tools used in the development environment. the version of tools used in the development environment.
Here are some dependents with specific version: Here are some dependents with specific version:
* golang : v1.15 * golang: v1.15
* misspell : latest * misspell: latest
* shellCheck : latest * shellCheck: latest
* docker: latest * docker: latest
When you develop the Dragonfly project at the local environment, When you develop the Dragonfly project in the local environment,
you should use subcommands of Makefile to help yourself you should use subcommands of Makefile to help yourself
to check and build the latest version of Dragonfly. to check and build the latest version of Dragonfly.
For the convenience of developers, For the convenience of developers,
we use the docker to build Dragonfly. we use docker to build Dragonfly.
It can reduce problems of the developing environment. It can reduce problems of the developing environment.
### Golang Dependency Management ### Golang Dependency Management
@ -287,10 +287,10 @@ collaborate. So the latest updates of Dragonfly are always here.
Although contributions via PR is an explicit way to help, Although contributions via PR is an explicit way to help,
we still call for any other ways. we still call for any other ways.
* Reply to other's issues if you could. * Reply to others' issues if you could.
* Help solve other user's problems. * Help solve other users' problems.
* Help review other's PR design. * Help review others' PR design.
* Help review other's codes in PR. * Help review others' codes in PR.
* Discuss about Dragonfly to make things clearer. * Discuss about Dragonfly to make things clearer.
* Advocate Dragonfly technology beyond GitHub. * Advocate Dragonfly technology beyond GitHub.
* Write blogs on Dragonfly and so on. * Write blogs on Dragonfly and so on.
@ -300,7 +300,7 @@ In a word, **ANY HELP IS CONTRIBUTION.**
## Join Dragonfly as a member ## Join Dragonfly as a member
It is also welcomed to join Dragonfly team if you are It is also welcomed to join Dragonfly team if you are
willing to participate in Dragonfly community continuously and keep active. willing to participate in Dragonfly community continuously and be active.
### Requirements ### Requirements

6
README.md
View File

@ -27,7 +27,7 @@ Currently Dragonfly focuses on being:
- Simple: well-defined user-facing API (HTTP), non-invasive to all container engines; - Simple: well-defined user-facing API (HTTP), non-invasive to all container engines;
- Efficient: CDN support, P2P based file distribution to save enterprise bandwidth; - Efficient: CDN support, P2P based file distribution to save enterprise bandwidth;
- Intelligent: host level speed limit, intelligent flow control due to host detection; - Intelligent: host-level speed limit, intelligent flow control due to host detection;
- Secure: block transmission encryption, HTTPS connection support. - Secure: block transmission encryption, HTTPS connection support.
Dragonfly is now hosted by the Cloud Native Computing Foundation (CNCF) as Dragonfly is now hosted by the Cloud Native Computing Foundation (CNCF) as
@ -74,10 +74,10 @@ warehouse services for various cloud vendors, etc.
each module depends on, and provide keepalive and metrics functions. each module depends on, and provide keepalive and metrics functions.
**Scheduler:** The tracker and scheduler in the P2P **Scheduler:** The tracker and scheduler in the P2P
network that choose appropriate downloading net-path for each peer. network that chooses appropriate downloading net-path for each peer.
**CDN:** A CDN server that caches downloaded data **CDN:** A CDN server that caches downloaded data
from source to avoid downloading same files repeatedly. from source to avoid downloading the same files repeatedly.
**Daemon:** It's a daemon of dfget client. **Daemon:** It's a daemon of dfget client.
It establishes a proxy between containerd/CRI-O and registry. It establishes a proxy between containerd/CRI-O and registry.