Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix contributing guidance #862

Merged
merged 1 commit into from Jun 27, 2019
Merged

Fix contributing guidance #862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/pages/getting-started.js
View file
Open in desktop
Expand Up @@ -55,10 +55,14 @@ export default () => (
than copy and paste the code.
</Paragraph>
<Paragraph>
If you need something that’s not in the Design System create and test a
solution in your product, and{" "}
<Link href="/#feedback">contribute it back</Link> if it solves a common
problem.
If you’re looking for something that’s not in the Design System, feel
free to design and test your own solution.
</Paragraph>
<Paragraph>
<Link href="/getting-started/contribute/">
Contribute to the Design System
</Link>{" "}
if you have a solution to a common problem.
</Paragraph>
<SignpostLink href="/">Go to the homepage</SignpostLink>
</Main>
Expand Down
64 changes: 64 additions & 0 deletions src/pages/getting-started/contribute.js
View file
Open in desktop
@@ -0,0 +1,64 @@
import React from "react";

import Breadcrumbs from "../../components/Breadcrumbs";
import BulletedList from "../../components/BulletedList";
import Lede from "../../components/Lede";
import Link from "../../components/Link";
import ListItem from "../../components/ListItem";
import Main from "../../components/Main";
import Page from "../../components/Page";
import Paragraph from "../../components/Paragraph";
import SignpostLink from "../../components/SignpostLink";
import Title from "../../components/Title";

export default () => (
<Page title="Contribute">
<Breadcrumbs
items={[
{
text: "Home",
href: "/"
},
{
text: "Getting started",
href: "/getting-started/"
}
]}
/>
<Main>
<Title>Contribute</Title>
<Lede>
Anyone creating digital products can contribute to the Design System.
</Lede>
<Paragraph>You should check whether:</Paragraph>
<BulletedList>
<ListItem>
the right <Link href="/components/">component</Link> already exists
</ListItem>
<ListItem>
you can adapt your needs to use an existing component
</ListItem>
</BulletedList>
<Paragraph>If the right component doesn’t exist you should:</Paragraph>
<BulletedList>
<ListItem>
check if there’s an{" "}
<Link href="https://github.com/barnardos/design-system/issues">
existing GitHub issue
</Link>
</ListItem>
<ListItem>create a new issue if one doesn’t exist </ListItem>
<ListItem>add detail including your research and user needs</ListItem>
</BulletedList>
<Paragraph />
<Paragraph>
When you’re ready to work on an issue, read the guidance on{" "}
<Link href="https://github.com/barnardos/design-system/blob/master/.github/CONTRIBUTING.md">
how to contribute code
</Link>{" "}
on Github.
</Paragraph>
<SignpostLink href="/">Go to the homepage</SignpostLink>
</Main>
</Page>
);
11 changes: 5 additions & 6 deletions src/pages/index.js
View file
Open in desktop
Expand Up @@ -57,15 +57,14 @@ export default () => (
</Link>
</ListItem>
<ListItem>
participate in the discussion on{" "}
<Link href="https://barnardos.facebook.com/groups/design.system/">
Workplace
</Link>
participate in the discussion
</Link>{" "}
on Workplace
</ListItem>
<ListItem>
contribute to the Design System on{" "}
<Link href="https://github.com/barnardos/design-system/blob/master/.github/CONTRIBUTING.md">
Github
<Link href="/getting-started/contribute/">
contribute to the Design System
</Link>
</ListItem>
</BulletedList>
Expand Down