Skip to content

Commit 1ffdfb7

Browse files
committed
Auto merge of #8715 - ehuss:contrib, r=alexcrichton
Add contributor guide. This consolidates and extends the contributor information in a single place. This is an mdbook project, along with a CI job which will build and deploy it to GitHub Pages at <https://rust-lang.github.io/cargo/contrib/>. You can view a rendered version here: <https://ehuss.github.io/cargo/contrib/> I don't know if this will actually be helpful to anyone, but I figured it's worth a shot. NOTE: The CI deploy is designed to preserve the existing gh-pages content. However, it will **delete the history** on that branch. I think that should be fine, there doesn't seem to be too much interesting stuff there. I do have a backup in my fork, though. Some extra scrutiny on the code might be wise. The reason it deletes the history is because deploying mdbook on every push would balloon the repository size.
2 parents 8835604 + b698b25 commit 1ffdfb7

File tree

27 files changed

+1425
-487
lines changed

27 files changed

+1425
-487
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Tracking Issue
3+
about: A tracking issue for an accepted feature or RFC in Cargo.
4+
title: Tracking Issue for XXX
5+
labels: C-tracking-issue
6+
---
7+
<!--
8+
Thank you for creating a tracking issue! Tracking issues are for tracking an
9+
accepted feature or RFC from implementation to stabilization. Please do not
10+
file a tracking issue until the feature or RFC has been approved.
11+
-->
12+
13+
**About tracking issues**
14+
15+
Tracking issues are used to record the overall progress of implementation.
16+
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
17+
A tracking issue is however *not* meant for large scale discussion, questions, or bug reports about a feature.
18+
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.
19+
20+
**Summary**
21+
22+
Original issue: #NNNN <!-- if there is a related issue that spawned this feature -->
23+
Implementation: #NNNN <!-- link to the PR that implemented this feature if applicable -->
24+
Documentation: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#my-feature
25+
26+
<!-- Write a very brief summary of the feature here. -->
27+
28+
**Unresolved issues**
29+
30+
* [ ] Make a list of any known implementation or design issues.
31+
32+
**Future extensions**
33+
34+
<!-- An optional section where you can mention where the feature may be extended in the future, but is explicitly not intended to address. -->

.github/workflows/contrib.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Contrib Deploy
2+
on:
3+
push:
4+
branches:
5+
- master
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
with:
13+
fetch-depth: 0
14+
- name: Install mdbook
15+
run: |
16+
mkdir mdbook
17+
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.3/mdbook-v0.4.3-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
18+
echo ::add-path::`pwd`/mdbook
19+
- name: Deploy docs
20+
run: |
21+
cd src/doc/contrib
22+
mdbook build
23+
git worktree add gh-pages gh-pages
24+
git config user.name "Deploy from CI"
25+
git config user.email ""
26+
cd gh-pages
27+
# Delete the ref to avoid keeping history.
28+
git update-ref -d refs/heads/gh-pages
29+
rm -rf contrib
30+
mv ../book contrib
31+
git add contrib
32+
git commit -m "Deploy $GITHUB_SHA to gh-pages"
33+
git push --force

ARCHITECTURE.md

Lines changed: 0 additions & 150 deletions
This file was deleted.

0 commit comments

Comments
 (0)