Commit Graph

30 Commits

Author SHA1 Message Date
Hector Ramos aadeff032f What to Expect from Maintainers
Summary:
Adds a new maintainers guide, and updates the contributor's guide to be consistent with regards to this new guide.

Some additional style changes made in order to support the display of bot commands. Changed the wording for the "Edit this page on GitHub" link.

Finally, the contributor's guide is now synced to `CONTRIBUTING.md` on the repo.

```
cd website && npm start
```

Verify that `CONTRIBUTING.md` is updated whenever the website is regenerated.

Verify everything rendered correctly. Expand the details below to see screenshots.

<details>

![screencapture-localhost-8079-react-native-docs-contributing-html-1501016495792](https://user-images.githubusercontent.com/165856/28593706-33d1e03c-7142-11e7-9878-04ead7561abc.png)

![screencapture-localhost-8079-react-native-docs-maintainers-html-1501016508744](https://user-images.githubusercontent.com/165856/28593719-3812d7fa-7142-11e7-9db2-f9599057d726.png)
</details>
Closes https://github.com/facebook/react-native/pull/15202

Differential Revision: D5494246

Pulled By: hramos

fbshipit-source-id: e28d5624d1e4795e212f10e8d5713d91a0eae15f
2017-07-28 08:18:53 -07:00
Hector Ramos d1c9746902 Move CONTRIBUTING guidelines to a standalone doc in the website.
Reviewed By: TheSavior

Differential Revision: D5448961

fbshipit-source-id: c8491b003413e8af22987ea578d6f7bbe1552b31
2017-07-19 10:23:06 -07:00
Hector Ramos 22ab231c2e Update templates, CONTRIBUTING
Summary:
Continuation of #14730 which didn't land cleanly.
Closes https://github.com/facebook/react-native/pull/14753

Differential Revision: D5329443

Pulled By: hramos

fbshipit-source-id: 2abb94d2aeaeb8694bebdc2dc0319520635d43cd
2017-06-27 09:40:24 -07:00
Hector Ramos 0d3b7fe472 Update guidelines.
Summary:
Consolidate tips on CONTRIBUTING.md, and reduce the wall of text when opening a new issue. Hoping this will encourage more people to read through the text.
Closes https://github.com/facebook/react-native/pull/14518

Differential Revision: D5250443

Pulled By: hramos

fbshipit-source-id: 91213c4ceca12225d9f54d1e1e81e020c6e463b3
2017-06-14 15:16:59 -07:00
Hector Ramos 28bb1960a4 Shorten template instructions.
Summary:
I've noticed many pull requests are opened with a very short description that fails to explain the motivation behind the PR, and many more forego providing a test plan. With this PR, I am shortening the template in order to provide concise instructions that provide the essential steps above the fold in the "Open a pull request" composer window.

- We need people to open a PR against master, not stable. The exact reason for this is not important and providing an explanation takes away from other more important points.
- Test plans are essential, but their requirement appears below the fold in the current template.
- More PRs could use tests.
- Make a point of asking PR authors to follow up on CI test failures.
- The composer does not parse Markdown into HTML. Markdown is pretty readable as is, but using reference links instead of inline links should help with readability.

I observed that it will only display the first 8 lines of the PR template above the fold. Seeing t
Closes https://github.com/facebook/react-native/pull/12958

Differential Revision: D4718294

Pulled By: mkonicek

fbshipit-source-id: b19a29e5ed73fb78d09c7de17625b1883590075c
2017-03-15 17:30:58 -07:00
Hector Ramos 6dab5dcd7c Link to Sketch and CRNA
Summary:
rnplay.org is shutting down on April 1st, 2017. Recommend instead using Expo's improved prototyping tool, Sketch.
Closes https://github.com/facebook/react-native/pull/12935

Differential Revision: D4709631

Pulled By: mkonicek

fbshipit-source-id: ebc020ca7973a23658dc3b63ad2ac81c2ecefe9c
2017-03-14 17:01:56 -07:00
Héctor Ramos 01cb1e4ef6 Update Edit on GitHub links to point to master
Summary:
We've been getting a lot of documentation PRs opened against `0.29-stable`, `0.30-stable`, and so on, instead of `master`. This is because our doc site is also based on RN release cuts, so clicking on the "Edit on GitHub" links on a document will take you to the markdown source for that release branch instead of the latest doc on `master`.

See #9095 for an example of such a PR.

In this PR we edit the link to say View on GitHub. Though it may not prevent PRs from being opened against a release branch, removing the "Edit" CTA may help in this regard.
Closes https://github.com/facebook/react-native/pull/9149

Differential Revision: D3664368

Pulled By: vjeux

fbshipit-source-id: 395c0813f736bfbe1be4b4fb1182f9060169365d
2016-08-03 17:43:49 -07:00
Fadil Sutomo faabeadebf Fix JSX string props quote convention
Summary:
Not sure if I misunderstand the previous JSX convention. But I found that in JSX string props, double-quote is preferred instead.

https://github.com/facebook/react-native/blob/master/.eslintrc#L182

![screen shot 2016-07-21 at 5 32 04 am](https://cloud.githubusercontent.com/assets/6204776/17006166/137db7ae-4f09-11e6-871b-2cf99960e3a1.png)
Closes https://github.com/facebook/react-native/pull/8933

Differential Revision: D3597084

fbshipit-source-id: 606a2123f1a1ff1fe2234b636b68b3273ebf6ebb
2016-07-20 20:13:27 -07:00
Joel Marcey 52b4ae179c Pull requests should target master branch
Summary:
Make it more obvious that pull requests should generally target the `master` branch. Provide visible clarity in both the `CONTRIBUTING.md` and the actual pull request template.
Closes https://github.com/facebook/react-native/pull/8748

Differential Revision: D3566827

fbshipit-source-id: 6326f18b93594e928b1c4e0d09a739a8ccedaa62
2016-07-14 19:13:45 -07:00
Janic Duplessis e08197b998 Add note about submitting PRs on master
Summary:
We got a lot of PRs on stable branches recently, this adds a note about that in CONTRIBUTING that (hopefully) people will read.
Closes https://github.com/facebook/react-native/pull/8209

Differential Revision: D3454813

fbshipit-source-id: 4f972d9e5edc1f13b249d9f7a627f84ba9826a0a
2016-06-18 02:43:20 -07:00
zxcpoiu f5b1f157ad improve CONTRIBUTING.md about Pull Request
Summary:
**motivation**

Lots of people does not sure what to do after a PR.
common questions like:

* should I keep rebasing this PR to the latest master branch ?
* should I keep squashing all commits in a PR into single one?

This may clear it a bit and makes people less nervous 😱

**Test plan (required)**
Closes https://github.com/facebook/react-native/pull/8081

Differential Revision: D3424076

fbshipit-source-id: 6c5f1b0b2f0bee03c647c2f8cad00b788130a5fc
2016-06-12 23:43:26 -07:00
Chris Geirman 60b2398cc5 add instructions for testing website locally
Summary:Explain the **motivation** for making this change. What existing problem does the pull request solve?

> When vjeux [asked me how the documentation changes looked](https://github.com/facebook/react-native/pull/6423#issuecomment-195608638), it wasn't obvious to me how to build and view them locally. So, I thought it might be a good idea to add instructions to the contributing document.

I was able to run the website locally when working on PR #6423 but am no longer able to now. I have since updated my local repo with a `git pull`. I've deleted the node_modules directories in both the root and website folders, rebuilding both. Still, I get the following error when I run `npm start` within the website directory (problem with the ES2015 compiling?)...

```bash
**/react-native/website/server/convert.js:134
    .filter(key => key.startsWith('RN_'))
                ^^
SyntaxError: Unexpected token =>
    at exports.runInThisContext (vm.js:73:16)
    at Module._compile (
Closes https://github.com/facebook/react-native/pull/6510

Differential Revision: D3070560

Pulled By: vjeux

fb-gh-sync-id: 6d200bb545d0ce357500cd666dd400ec82fafa92
shipit-source-id: 6d200bb545d0ce357500cd666dd400ec82fafa92
2016-03-18 12:15:26 -07:00
Martin Konicek f0f1f61b40 Update PR and issue templates and guidelines
Summary:- Simplified the PR and Issue template to make them easier to read.
- Add a very simple guide for reviewing PRs (cc bestander, feel free to add to this)
Closes https://github.com/facebook/react-native/pull/6295

Differential Revision: D3011905

fb-gh-sync-id: 4929921690a6996e574e6b152a9dd41087cfffdc
shipit-source-id: 4929921690a6996e574e6b152a9dd41087cfffdc
2016-03-04 09:20:37 -08:00
James Ide b051d07b81 Update CONTRIBUTING.md 2016-02-10 12:46:26 -08:00
Max 3a76f83f7b Add mention of the license comment in CONTRIBUTING.md
See this comment of PR #4866: https://github.com/facebook/react-native/pull/4866#issuecomment-166612075
2015-12-24 10:27:29 +01:00
James Ide a659c9346c [Docs] Fix up small typo in code style docs 2015-12-07 23:24:23 -08:00
James Ide c031ccdc57 JSX style
Wrote some notes on the standard JSX / XHP style
2015-12-07 23:23:26 -08:00
Martin Konicek 99b4901f6b Update CONTRIBUTING.md 2015-11-18 18:09:52 +00:00
Martin Konicek 3c5f3b1dfc Update CONTRIBUTING.md 2015-11-17 21:51:02 +00:00
Brent Vatne d03bf216b1 Remove link to IRC in CONTRIBUTING.md, not used anymore 2015-10-19 12:27:17 -07:00
Dmitry 419549b116 Add info about react-native channel on DiscordApp 2015-10-19 20:47:03 +05:00
James Ide b9049ee96d [README] Added note about squashing commits to the Contributing page 2015-09-07 23:32:31 -07:00
John Yeglinski 199d1e425f Fixed grammar in CLA section of contribution guide
Removed the quotes from CLA acronym to adhere to MLA style guide
2015-06-12 09:34:53 -07:00
Brent Vatne 571aa55ef5 Update CONTRIBUTING.md - ask for a runnable example for bugs 2015-05-23 15:49:41 -07:00
Spencer Ahrens a1193b7a93 Update CONTRIBUTING.md 2015-05-18 12:25:09 -07:00
Tadeu Zagallo 5db06ac511 Add some common objc nits to the style guide
@nicklockwood @a2 @vjeux Want to add something else? (or remove something)
2015-04-24 21:16:12 +01:00
Adam Barth ff41559280 Add a link to the Facebook community
Someone on IRC mentioned the Facebook community for React Native, but I don't
see it mentioned in any of the docs.
2015-04-10 18:17:11 -07:00
Spencer Ahrens f50ac9ea31 Tweak contributors agreement 2015-03-26 10:23:15 -07:00
Christopher Chedeau a439cd206e Update CONTRIBUTING.md 2015-03-23 10:49:51 -07:00
Christopher Chedeau 6938f45246 Update license 2015-03-23 10:48:39 -07:00