Commit Graph

23 Commits

Author SHA1 Message Date
Riccardo Cipolleschi
3ac7a5ef4e Fix: Adapt template to new rules (#36705)
Summary:
Recently, we changed the logic to verify the body of a PR so that it is more compatible internally and externally, in both ways. But we forgot to update the template, so right
now, all the created PR are incompatible with the internal PR checker.
The required change is to have `:` after the Changelog title.
For consistency, I added the `:` after ALL the titles.

## Changelog:

[Internal] - Changed the PR template to align it to the new rules

Pull Request resolved: https://github.com/facebook/react-native/pull/36705

Test Plan: No danger errors nor internal linter errors

Reviewed By: christophpurrer

Differential Revision: D44503519

Pulled By: cipolleschi

fbshipit-source-id: 43963c3cf774d19d6de8e86b18b684e76dd0fe87
2023-03-29 09:17:53 -07:00
Lorenzo Sciandra
e509007f57 fix(internal, dangerfile): fix changelog entries for dangerfiles and PR template (#35541)
Summary:
A few days back leotm pointed out how the dangerfile was disaligned with the docs around the valid changelog entries for categories and types here: https://github.com/facebook/react-native/pull/35443#issuecomment-1327449113

I dug a bit deeper into the whole thing and went to the source of truth, which is the changelog generator, in particular here: https://github.com/microsoft/rnx-kit/blob/main/incubator/rn-changelog-generator/src/utils/getChangeDimensions.ts

So I've updated the dangerfile to respect the options listed there. Also did a parallel PR on the website side: https://github.com/facebook/react-native-website/pull/3447

So now all comms will be aligned.

## Changelog

<!-- Help reviewers and the release process by writing your own changelog entry. For an example, see:
https://reactnative.dev/contributing/changelogs-in-pull-requests
-->

[INTERNAL] [FIXED] - fix changelog entries for dangerfiles and PR template

Pull Request resolved: https://github.com/facebook/react-native/pull/35541

Test Plan: N/A

Reviewed By: sammy-SC

Differential Revision: D41686913

Pulled By: cortinico

fbshipit-source-id: 2297b4a3209188bda4a609b60860de35c5e7e6df
2022-12-05 02:38:42 -08:00
Antoine Doubovetzky
1d997ce6d6 (PULL_REQUEST_TEMPLATE) update link to changelog documentation (#34206)
Summary:
I just opened another PR and noticed the changelog page in the wiki redirected to the react native documentation.

## Changelog

<!-- Help reviewers and the release process by writing your own changelog entry. For an example, see:
https://github.com/facebook/react-native/wiki/Changelog
-->

[Internal] [Changed] - Update link to changelog documentation in PULL_REQUEST_TEMPLATE

Pull Request resolved: https://github.com/facebook/react-native/pull/34206

Reviewed By: NickGerleman

Differential Revision: D37920424

Pulled By: cortinico

fbshipit-source-id: f4e47172a13fe5b42c29e320d34816b490a14b6c
2022-07-19 05:47:17 -07:00
Pavlos Vinieratos
74ee32c77e Make the link easier to copy. (#28516)
Summary:
Making a PR from GitHub, I need to copy-paste the link, and it would be easier to just triple-click a line with the URL rather than carefully selecting the URL from the text.

<img width="723" alt="Screen Shot 2020-04-03 at 17 33 47" src="https://user-images.githubusercontent.com/100233/78378550-6c12af80-75d1-11ea-93a4-2eae568ce602.png">

## Changelog

[General] [Changed] - Make PR template easier to use with changelog URL.
Pull Request resolved: https://github.com/facebook/react-native/pull/28516

Reviewed By: fkgozali

Differential Revision: D20842238

Pulled By: hramos

fbshipit-source-id: 3fef7a994f36a996bbbc52556600d468a56210a9
2020-04-03 11:52:35 -07:00
Héctor Ramos
9c3f4c021e Bots cleanup, avoid leaving inline reviews when N>5 (#24923)
Summary:
This PR cleans up some of our GitHub bots. The overall goal is to make the contribution process just a tad nicer.

### analysis-bot

* The bot will continue leaving GitHub Reviews when it finds lint issues, but will abstain from leaving inline comments if they would exceed 5 in number.
* The review comment left by the bot has instructions on how to reproduce the lint issues locally. This will educate PR authors on how to run lint and fix the issues without unnecessarily spamming the PR with 50+ comments, while still providing useful reviews to authors when only a handful of lint issues slip by.
* Code moved to `bots/` directory for ease of discovery and co-location with pull-bot.
* Added `yarn lint-ci` command. This seems like the right choice: it's running `yarn lint` and other linters, and it is only intended to run on CI.
* It's still possible to run `yarn lint-ci` locally, though the script will stop short of posting a review to GitHub unless the necessary envvars are provided.
* Added `yarn shellcheck` command. This can be run locally, though it requires `shellcheck` to be installed.
* Outside of this PR, I added instructions on using shellcheck to https://github.com/facebook/react-native/wiki/Development-Dependencies
* Updated Circle CI config to use these new commands, and streamlined the `analyze_pr` step.
* Documented analysis-bot in `bots/README.md`.

### pull-bot

* Bumped `danger-js` dependency. No breaking changes found in this minor bump from what I can tell.
* Documented pull-bot in `bots/README.md`.

### misc

* PR template: don't use jargon.

## Changelog

[Internal] [Changed] - GitHub Bots cleanup
Pull Request resolved: https://github.com/facebook/react-native/pull/24923

Differential Revision: D15399744

Pulled By: hramos

fbshipit-source-id: 32632e775f8554424072270e3f98542de84bfb8c
2019-05-21 19:38:54 -07:00
Eric Lewis
06bb76abd9 Update PR template changelog link (#24919)
Summary:
fix #24917.

## Changelog

[Internal] [Changed] - Update PR template changelog link
Pull Request resolved: https://github.com/facebook/react-native/pull/24919

Differential Revision: D15385773

Pulled By: hramos

fbshipit-source-id: 81a220efc3999942bd41ddf7cbd3107a755cfebd
2019-05-16 16:45:21 -07:00
Héctor Ramos
9bcd98f1a9 Update issue templates (#23296)
Summary:
Go back to simpler issue template titles, with emoji. The goal is to make it easier, at a glance, to pick the right template.

We also add a new "regression" template that will automatically label the issue as a regression.

Other changes:
- Added Christoph as a CODEOWNER for package.json and markdown file changes. Usually, any PR that touches package.json has to be imported manually by a Facebook employee.

[General] [Changed] - Updated GitHub issue templates.
Pull Request resolved: https://github.com/facebook/react-native/pull/23296

Differential Revision: D13974378

Pulled By: hramos

fbshipit-source-id: d8962a84397c16e7556ac167a3505f7c7d725915
2019-02-06 11:23:12 -08:00
cpojer
7bb7f0159d Update Pull Request and Issue templates. (#23187)
Summary:
As a maintainer, I noticed that the description for a PR is often missing, which makes it hard to understand why a change is made. Because some of the text isn't using HTML comments, the same text explaining how to fill out the changelog and test plan pops up and isn't removed by people. This PR fixes both of these issues.

I also made another small update to the main issue template to urge people to use one of the other templates, with an explanation that we will close poorly formatted issues.

Changelog:
----------

[General] [Changed] - Updated GitHub templates
Pull Request resolved: https://github.com/facebook/react-native/pull/23187

Differential Revision: D13877752

Pulled By: cpojer

fbshipit-source-id: 8ed88cde9151a41931848cccc669208cabe1e9ef
2019-01-30 08:36:50 -08:00
Héctor Ramos
d162217609 Rearrange PR Template (#22683)
Summary:
This ensures the changelog is captured as part of the commit description, and not the test plan, when the PR is imported into Phabricator
Pull Request resolved: https://github.com/facebook/react-native/pull/22683

Differential Revision: D13498624

Pulled By: hramos

fbshipit-source-id: 59a7e7e8c6f76973d3cfb97dea0e56af43673a9b
2018-12-17 15:43:41 -08:00
Ryan Turner
ce18036c35 Make PR template consistent with Changelog (#22117)
Summary:
In the new changelog format, we're following [Keep a Changelog](https://keepachangelog.com/en/1.0.0). This change updates the PR template to follow their change types, plus it simplifies the *CATEGORY* field to follow the changelog's groupings. Some simplified examples have been provided, though I plan to revisit this after 0.58 to add real-world examples. This change is motivated by react-native-community/react-native-releases#47.
Pull Request resolved: https://github.com/facebook/react-native/pull/22117

Differential Revision: D12919271

Pulled By: TheSavior

fbshipit-source-id: 91f063f769357b24383db281545678b924ad3efb
2018-11-04 11:29:52 -08:00
Héctor Ramos
c1f884e6f0 Add test case suggestion to PR template
Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/21234

Differential Revision: D9982500

Pulled By: hramos

fbshipit-source-id: 585d4a8292ac7f53f26adf53a36e766a49fdc5b6
2018-09-20 17:47:52 -07:00
Héctor Ramos
eccf536ee9 Update PULL_REQUEST_TEMPLATE.md (#19813)
Summary:
Use colon after Test Plan to ensure the plan is copied to Facebook's internal Phabricator instance successfully.
Closes https://github.com/facebook/react-native/pull/19813

Differential Revision: D8530181

Pulled By: hramos

fbshipit-source-id: 83be6ecaca54a3c6fd4e47b08b8632976f5635aa
2018-06-19 23:48:12 -07:00
Héctor Ramos
6426735e82 Simplify templates
Summary:
Trivial PR.

[GENERAL][MINOR][.circleci/, bots/] - Simplify GitHub templates
Closes https://github.com/facebook/react-native/pull/18418

Differential Revision: D7311869

Pulled By: hramos

fbshipit-source-id: b87599c53938406d585d711492aacbdde2fcb02a
2018-03-16 17:22:05 -07:00
Héctor Ramos
c49b97c4ef Update PULL_REQUEST_TEMPLATE.md
Summary:
Quick edit to ensure people are aware of the new docs location.
Closes https://github.com/facebook/react-native/pull/17085

Differential Revision: D6492000

Pulled By: hramos

fbshipit-source-id: 6ec2b5d2dadb30cefb1d23c740ca5449b3998468
2017-12-05 16:46:28 -08:00
Tim Wang
de3976a486 Fix typo in PULL_REQUEST_TEMPLATE.md
Summary:
Found a typo.

N/A

 [INTERNAL] [MINOR] [GitHub] -Fix typo in PULL_REQUEST_TEMPLATE.md
Closes https://github.com/facebook/react-native/pull/16723

Differential Revision: D6260883

Pulled By: hramos

fbshipit-source-id: 7feb8ba60f5c63849ef89ef8385c7ddf52ed65e3
2017-11-07 10:34:10 -08:00
Trevor Brindle
9877c08855 add release notes/changelog requirement to PR Template
Summary:
grabbou has to write release notes for every release, and that's getting ridonc. Have you seen the changelog from 0.48?

PR writers need to do their own, hopefully in a standardized format so it can be scripted.

Just a PR template change, just proofreading needed. Please mention if have missed or added any extra Categories, Types, or Where columns.

Here's a sample:

[GENERAL] [ENHANCEMENT] [PULL_REQUEST_TEMPLATE.md] - added release notes/changelog requirement to PR Template
Closes https://github.com/facebook/react-native/pull/15874

Differential Revision: D6054557

Pulled By: hramos

fbshipit-source-id: 5741b98a0efdb1a6aaaeedaa292403b82ce713f6
2017-10-13 13:35:25 -07:00
Hector Ramos
5be8c4af26 Cleanup stray markdown files, update contributing guidelines
Summary:
Several changes here. The `Text.md` and `PixelRatio.md` files were appended to the autodocs during site generation. This seemed excessive for just two files, so I've just merged the content into the autodocs themselves. It should help us simplify the website generation process in the future.

I've also merged IssueGuidelines.md and PullRequestGuidelines.md into the Contribution/Maintainers guidelines to improve their visibility.

Finally, I renamed Help to Community in the nav bar.

Ran the website locally, and verified every page rendered as expected: the Community page, Contributing page, Maintainers page.
Closes https://github.com/facebook/react-native/pull/15374

Differential Revision: D5567400

Pulled By: hramos

fbshipit-source-id: e06056edb12c9a17319fe1af46b2ef3a2e1b5854
2017-08-04 16:18:01 -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
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
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
Zakaria Ridouh
97cfacb5ba move templates to .github folder
Summary:
This moves the Template files to the .github folder. This helps clear up the extra files in the root of the directory.

This is my first PR 😄  and I plan to contribute more to this awesome project.
Closes https://github.com/facebook/react-native/pull/7854

Differential Revision: D3424679

fbshipit-source-id: 2baca0bb4182eb6d803836e10a5434d980e7d0c3
2016-06-13 07:43:28 -07:00