pesde-pkg/pesde
1
1
Fork 0
mirror of https://github.com/pesde-pkg/pesde.git synced 2025-05-04 10:33:47 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs(policies): explain & cover more cases

Browse source
This commit is contained in:
daimond113 2024-10-14 23:07:31 +02:00 • committed by LukaDev
parent bc9df65c89
commit 7f8ca70dab
1 changed files with 57 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
docs/src/content/docs/registry/policies.md
View file

@ -3,64 +3,94 @@ title: Policies
description: Policies for the pesde registry description: Policies for the pesde registry
--- ---
If anything is unclear, please [contact us](#contact-us). and we will be happy The following policies apply to the [official public pesde registry](https://registry.pesde.daimond113.com)
and its related services, such as the index repository or websites.
They may not apply to other registries. By using the pesde registry, you agree
to these policies.
If anything is unclear, please [contact us](#contact-us), and we will be happy
to help. to help.
## Contact Us ## Contact Us
You can contact us at [pesde@daimond113.com](malto:pesde@daimond113.com). You can contact us at [pesde@daimond113.com](mailto:pesde@daimond113.com). In
case of a security issue, please prefix the subject with `[SECURITY]`.
## Permitted content ## Permitted content
The pesde registry is a place for Luau packages. Examples of allowed content: The pesde registry is a place for Luau-related packages. This includes:
- Libraries - Libraries
- Frameworks - Frameworks
- Tools
Examples of disallowed content: The following content is forbidden:
- Malicious code - Malicious, vulnerable code
- Illegal content - Illegal, harmful content
- Miscellaneous files (doesn't include configuration files, documentation, etc.)
pesde is not responsible for the content of packages. If you believe a package pesde is not responsible for the content of packages, the scope owner is. It
is breaking these requirements, please [contact us](#contact-us). is the responsibility of the scope owner to ensure that the content of their
packages is compliant with the permitted content policy.
If you believe a package is breaking these requirements, please [contact us](#contact-us).
## Package removal ## Package removal
pesde does not support removing packages from the registry without a reason such pesde does not support removing packages for reasons such as abandonment. A
as security or complying with the law in order. In case a secret has been package may only be removed for the following reasons:
published to the registry, it must be invalided. If you believe a package should
be removed, please [contact us](#contact-us). We will review your request and - The package is breaking the permitted content policy
take action if necessary. - The package contains security vulnerabilities
- The package must be removed for legal reasons (e.g. DMCA takedown)
In case a secret has been published to the registry, it must be invalidated.
If you believe a package should be removed, please [contact us](#contact-us).
We will review your request and take action if necessary.
If we find that a package is breaking the permitted content policy, we will If we find that a package is breaking the permitted content policy, we will
remove it from the registry without notice. exercise our right to remove it from the registry without notice.
pesde reserves the right to remove any package from the registry at any time for pesde reserves the right to remove any package from the registry at any time for
any or no reason, without notice. any or no reason, without notice.
## Package ownership ## Package ownership
Packages are owned by scopes. The first person to publish to a scope owns it. If Packages are owned by scopes. Scope ownership is determined by the first person
you want to work as a team, the owner of the scope must send a pull request to to publish a package to the scope. The owner of the scope may send a pull request
the index repository adding the members' user IDs to the scope's `scope.toml` to the index repository adding team members' user IDs to the scope's `scope.toml`
file. file to give them access to the scope, however at least one package must be
published to the scope before this can be done. The owner may also remove team
members from the scope.
A scope's true owner's ID must appear first in the `owners` field of the scope's
`scope.toml` file. Ownership may be transferred by the current owner sending a
pull request to the index repository, and the new owner confirming the transfer.
Only the owner may add or remove team members from the scope.
pesde reserves the right to override scope ownership in the case of a dispute,
such as if the original owner is unresponsive or multiple parties claim ownership.
## Scope squatting ## Scope squatting
Scope squatting is the act of creating a scope with the intent of preventing Scope squatting is the act of creating a scope with the intent of preventing
others from using it. Scope squatting is not allowed. If you believe a scope is others from using it, without any intention of using it yourself. This is
being squatted, please [contact us](#contact-us). We will review your request forbidden and can result in the removal (release) of the scope and its packages
and take action if necessary. from the registry without notice.
If you believe a scope is being squatted, please [contact us](#contact-us).
We will review your request and take action if necessary.
## API Usage ## API Usage
The pesde registry has an API for searching packages, downloading, and The pesde registry has an API for querying, downloading, and publishing packages.
publishing them. Only non-malicious use is permitted. Malicious uses include: Only non-malicious use is permitted. Malicious uses include:
- **Service Degradation**: this includes sending the registry an excessive - **Service Degradation**: this includes sending an excessive amount of requests
amount of requests to the registry in order to degrade the service
- **Exploitation**: this includes trying to break security of the registry in - **Exploitation**: this includes trying to break the security of the registry
order to gain unauthorized access to resources in order to gain unauthorized access
- **Harmful content**: this includes publishing harmful (non-law compliant, - **Harmful content**: this includes publishing harmful (non-law compliant,
purposefully insecure) content purposefully insecure) content