Skip to content

Commit

Permalink
Docs: Move CONTRIBUTING.md to docs/
Browse files Browse the repository at this point in the history
  • Loading branch information
ockham committed Oct 10, 2019
1 parent cea9c70 commit 8e3fd6b
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 24 deletions.
10 changes: 3 additions & 7 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,36 @@
<!-- Thanks for contributing to Calypso! Pick a clear title ("Editor: add spell check") and proceed. -->

#### Steps to reproduce

1. Starting at URL:
2.
3.
4.

#### What I expected


#### What happened instead


#### Browser / OS version


#### Screenshot / Video


#### Context / Source

<!-- Optional: share your unique context to help us understand your perspective. You can add context tags such as: #journey #anecdote #narrative #context #empathy #perspective #reallife #dogfooding #livesharing #flowsharing #anxiety #anxiety-flow #stresscase #painpoint.
We'd also love to know how you found the bug: #dogfooding, #manual-testing, #automated-testing, or #user-report if applicable.
If requesting a new feature, explain why you'd like to see it added.
-->



<!--
PLEASE NOTE
- These comments won't show up when you submit the issue.
- Everything is optional, but try to add as many details as possible.
Docs & troubleshooting:
https://github.com/Automattic/wp-calypso/blob/master/.github/CONTRIBUTING.md
https://github.com/Automattic/wp-calypso/blob/master/docs/CONTRIBUTING.md
https://github.com/Automattic/wp-calypso/blob/master/docs/troubleshooting.md
Helpful tips for screenshots:
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ You can read more about Calypso at [developer.wordpress.com/calypso](https://dev

You can try out the user-side of Calypso on [WordPress.com](https://wordpress.com/) (a lot of the logged-in area is Calypso; if in doubt, view source), you can poke around the code here on GitHub, or you can install it and run it locally. The latter is the most fun.

1. Make sure you have [`git`](https://git-scm.com/), [`node`](https://nodejs.org/), and [`npm`](https://www.npmjs.com/get-npm) installed.
2. Clone this repository locally.
3. Add `127.0.0.1 calypso.localhost` to your local `hosts` file.
4. Execute `npm start` from the root directory of the repository.
5. Open [`calypso.localhost:3000`](http://calypso.localhost:3000/) in your browser.
1. Make sure you have [`git`](https://git-scm.com/), [`node`](https://nodejs.org/), and [`npm`](https://www.npmjs.com/get-npm) installed.
2. Clone this repository locally.
3. Add `127.0.0.1 calypso.localhost` to your local `hosts` file.
4. Execute `npm start` from the root directory of the repository.
5. Open [`calypso.localhost:3000`](http://calypso.localhost:3000/) in your browser.

Need more detailed installation instructions? [We have them](./docs/install.md).

## Contributing

If Calypso sparks your interest, don’t hesitate to send a pull request, send a suggestion, file a bug, or just ask a question. We promise we’ll be nice. Just don’t forget to check out our [CONTRIBUTING](./.github/CONTRIBUTING.md) doc – it includes a few technical details that will make the process a lot smoother.
If Calypso sparks your interest, don’t hesitate to send a pull request, send a suggestion, file a bug, or just ask a question. We promise we’ll be nice. Just don’t forget to check out our [CONTRIBUTING](./docs/CONTRIBUTING.md) doc – it includes a few technical details that will make the process a lot smoother.

Calypso welcomes – and indeed has been built by – contributors from all walks of life, with different backgrounds, and with a wide range of experience. We're committed to doing our part to make both Calypso and the wider WordPress community welcoming to everyone.

Expand All @@ -38,7 +38,7 @@ Need to report a security vulnerability? Go to [https://automattic.com/security/

## Browser Support

We support the latest two versions of all major browsers, except IE, where we currently only support 11 and Edge. (see [Browse Happy](https://browsehappy.com/) for current latest versions).
We support the latest two versions of all major browsers, except IE, where we currently only support 11 and Edge. (see [Browse Happy](https://browsehappy.com/) for current latest versions).

## Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion bin/pre-commit-hook.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const _ = require( 'lodash' );
console.log(
'\nBy contributing to this project, you license the materials you contribute ' +
'under the GNU General Public License v2 (or later). All materials must have ' +
'GPLv2 compatible licenses — see .github/CONTRIBUTING.md for details.\n\n'
'GPLv2 compatible licenses — see docs/CONTRIBUTING.md for details.\n\n'
);

// Make quick pass over config files on every change
Expand Down
2 changes: 1 addition & 1 deletion bin/pre-push-hook.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const readline = require( 'readline-sync' );
console.log(
'\nBy contributing to this project, you license the materials you contribute ' +
'under the GNU General Public License v2 (or later). All materials must have ' +
'GPLv2 compatible licenses — see .github/CONTRIBUTING.md for details.\n\n'
'GPLv2 compatible licenses — see docs/CONTRIBUTING.md for details.\n\n'
);

const currentBranch = execSync( 'git rev-parse --abbrev-ref HEAD' )
Expand Down
2 changes: 1 addition & 1 deletion client/devdocs/error.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default class extends React.PureComponent {
<img alt="WordPress" src="/calypso/images/illustrations/illustration-404.svg" />
<p>
Are we missing documentation? Could our docs be improved? Let us know by{' '}
<a href="/devdocs/.github/CONTRIBUTING.md">filing a GitHub issue</a>!
<a href="/devdocs/docs/CONTRIBUTING.md">filing a GitHub issue</a>!
</p>
</div>
);
Expand Down
2 changes: 1 addition & 1 deletion client/devdocs/main.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import './style.scss';
const DEFAULT_FILES = [
'docs/guide/index.md',
'README.md',
'.github/CONTRIBUTING.md',
'docs/CONTRIBUTING.md',
'docs/coding-guidelines.md',
'docs/coding-guidelines/javascript.md',
'docs/coding-guidelines/css.md',
Expand Down
4 changes: 2 additions & 2 deletions client/devdocs/sidebar.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ export default class DevdocsSidebar extends React.PureComponent {
className="devdocs__navigation-item"
icon="pencil"
label="Contributing"
link="/devdocs/.github/CONTRIBUTING.md"
selected={ this.isItemSelected( '/devdocs/.github/CONTRIBUTING.md' ) }
link="/devdocs/docs/CONTRIBUTING.md"
selected={ this.isItemSelected( '/devdocs/docs/CONTRIBUTING.md' ) }
/>
<SidebarItem
className="devdocs__navigation-item"
Expand Down
2 changes: 1 addition & 1 deletion client/extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Before you get started we encourage you to get familiar with our [development va
[development values]: https://wpcalypso.wordpress.com/devdocs/docs/guide/0-values.md
[data approach]: https://wpcalypso.wordpress.com/devdocs/docs/our-approach-to-data.md
[docs]: https://wpcalypso.wordpress.com/devdocs
[prs]: https://wpcalypso.wordpress.com/devdocs/.github/CONTRIBUTING.md#pull-requests
[prs]: https://wpcalypso.wordpress.com/devdocs/docs/CONTRIBUTING.md#pull-requests

## Defining a new section

Expand Down
2 changes: 1 addition & 1 deletion client/lib/abtest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ if ( abtest( 'freeTrialButtonWording' ) === 'startFreeTrial' ) {

You should keep the translation comment to make it clear to people reading the code why the string is not translated.

When this code runs the first time, we'll fire a `calypso_abtest_start` Tracks event with two properties: `abtest_name` and `abtest_variation`. This information is used by Tracks to help you analyze the impact of your test. For logged-in users, this event is fired via POST request to the `/me/abtest` endpoint and can be seen in a browser's network tab. For logged-out users, this event is fired via the [analytics.tracks.recordEvent method](https://github.com/Automattic/wp-calypso/tree/master/client/lib/analytics#tracks-api) and can be seen by watching the `calypso:analytics` string via [the debug module](https://github.com/Automattic/wp-calypso/blob/master/.github/CONTRIBUTING.md#debugging). The event is fired when there is no variant stored for a given test in localStorage. So you can trigger the event again by removing the record from localStorage.
When this code runs the first time, we'll fire a `calypso_abtest_start` Tracks event with two properties: `abtest_name` and `abtest_variation`. This information is used by Tracks to help you analyze the impact of your test. For logged-in users, this event is fired via POST request to the `/me/abtest` endpoint and can be seen in a browser's network tab. For logged-out users, this event is fired via the [analytics.tracks.recordEvent method](https://github.com/Automattic/wp-calypso/tree/master/client/lib/analytics#tracks-api) and can be seen by watching the `calypso:analytics` string via [the debug module](https://github.com/Automattic/wp-calypso/blob/master/docs/CONTRIBUTING.md#debugging). The event is fired when there is no variant stored for a given test in localStorage. So you can trigger the event again by removing the record from localStorage.

Also, the user's variation is saved in local storage. You can see this in Chrome's dev tools by going to Application > Local Storage > Calypso URL and viewing the `ABTests` key. If you'd like to force a specific variation while testing, you can simply change the value for your particular test then reload the page. In the example above, you'd change the value for `freeTrialButtonWording_20150216` to either `startFreeTrial` or `beginYourFreeTrial`.

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/guide/navigation-terminology.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ The actionbar shows up only on the frontend of sites. It is there to provide con

In development environments, when you're developing Calypso, you'll see a badge in the bottom right corner.

Previous: [Information Architecture](information-architecture.md) Next: [Contributing to Calypso](../../.github/CONTRIBUTING.md)
Previous: [Information Architecture](information-architecture.md) Next: [Contributing to Calypso](../../docs/CONTRIBUTING.md)
2 changes: 1 addition & 1 deletion server/devdocs/integration/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ describe( 'devdocs', () => {
getDocument( 'README.md', ( err, res ) => {
expect( err ).toBeNull();
expect( res.statusCode ).toBe( 200 );
expect( res.text ).toContain( '<a href="./.github/CONTRIBUTING.md">' );
expect( res.text ).toContain( '<a href="./docs/CONTRIBUTING.md">' );
done();
} );
} );
Expand Down

0 comments on commit 8e3fd6b

Please sign in to comment.