Skip to content

Commit

Permalink
Add policy around automated tools claiming names
Browse files Browse the repository at this point in the history
  • Loading branch information
sgrif committed Jan 28, 2019
1 parent 41c44b4 commit 7a3c210
Showing 1 changed file with 6 additions and 43 deletions.
49 changes: 6 additions & 43 deletions app/templates/policies.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ them. If necessary, the team may reach out to inactive maintainers and help
mediate the process of ownership transfer.
</p>

<p>
Using an automated tool to claim ownership of a large number of package names
is not permitted. We reserve the right to block traffic or revoke ownership
of any package we determine to have been claimed by an automated tool.
</p>

<h2 id='removal'><a href='#removal'>Removal</a></h2>

<p>
Expand Down Expand Up @@ -101,46 +107,3 @@ more details.
<p>
Thank you for taking the time to responsibly disclose any issues you find.
</p>

<h2 id='crawlers'><a href='#crawlers'>Crawlers</a></h2>

<p>
Before resorting to crawling crates.io, you should first see if you are able to
gather the information you need from the <a href='https://github.com/rust-lang/crates.io-index'>
crates.io index</a>, which is a public git repository containing the majority
of the information availble through our API.

If the index does not have the information you need, we're also happy to
discuss solutions to your needs that don't require you to crawl the registry.
You can email us at <a href="mailto:help@crates.io">help@crates.io</a>.
</p>

<p>
We allow our API and website to be crawled by commercial crawlers such as
GoogleBot. At our discretion, we may choose to allow access to experimental
crawlers, as long as they limit their request rate to 1 request per second or
less.
</p>

<p>
We also require all crawlers to provide a user-agent header that allows us to
uniquely identify your bot. This allows us to more accurately monitor any
impact your bot may have on our service. Providing a user agent that only
identifies your HTTP client library (such as "<code>request/0.9.1</code>") increases the
likelihood that we will block your traffic.

It is recommended, but not required, to include contact information in your user
agent. This allows us to contact you if we would like a change in your bot's
behavior without having to block your traffic.
</p>

<p>
Bad: "<code>User-Agent: reqwest/0.9.1</code>"<br>
Better: "<code>User-Agent: my_bot</code>"<br>
Best: "<code>User-Agent: my_bot (my_bot.com/info)</code>" or "<code>User-Agent: my_bot (help@my_bot.com)</code>"
</p>

<p>
We reserve the right to block traffic from any bot that we determine to be in
violation of this policy or causing an impact on the integrity of our service.
</p>

0 comments on commit 7a3c210

Please sign in to comment.