Commit graph

83 commits

Author SHA1 Message Date
Andrew Kolos 236a131cff
update link to good first issues (#130759)
Today (Jul 17, 2023), I renamed the `good first contribution` label to `good first issue`. This is because
1) `good first issue` is more commonly used for this intent across GitHub and and thus may be (ever so slightly) more recognizable to potential new contributors, and, more importantly,
2) GitHub recognizes the label `good first issue` when surfacing good first issues in specific places in GitHub[^1].

This PR updates Contributing.md to match the new name.

`grep` did not find any other references to `good first contribution` to update in this repo.

[^1]: [Source (GitHub docs)](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/encouraging-helpful-contributions-to-your-project-with-labels). Example: https://github.com/flutter/flutter/contribute. If my vague memory serves me correctly, this can also appear in certain emails or the "discovery queue"-type experience that GitHub provides.
2023-07-17 23:51:14 +00:00
Ian Hickson 3c61b9d834
add link to design doc wiki page (#127442) 2023-06-01 02:39:15 +00:00
prateekbytes a9f8e0279b
Typo error in CONTRIBUTING.md fixed (#111401)
I found a typo error in CONTRIBUTING.md and fixed it.
2022-09-12 20:53:04 +02:00
Ian Hickson 9afc72337f
Sync with https://github.com/flutter/.github/pull/13 (#108754) 2022-08-01 14:25:39 -07:00
Ian Hickson dc6a7812e9
Sync CONTRIBUTING.md with .github copy (#106677) 2022-06-27 18:58:05 +00:00
Ian Hickson ff9d6e5e33
Add more things to CONTRIBUTING.md (#101875)
* Add more things to CONTRIBUTING.md

* I forgot about QA!
2022-04-14 08:48:29 -07:00
Ian Hickson eb8a47454c
Add link to good first contributions (#100938) 2022-03-28 20:10:11 -07:00
Viren Khatri 75e7e556e5
Links How to contribute to Flutter YouTube video (#96313) 2022-01-07 16:35:09 -08:00
Ian Hickson c05d283be1
add internal comment to point to .github repo (#91052) 2021-10-01 01:18:05 -07:00
Ian Hickson 5b8c7c5dac
Minor tweaks to CONTRIBUTING.md (#73375) 2021-01-06 16:54:03 -08:00
Ayush Bherwani 7877d46c8b
[CONTRIBUTING.md] adds Contributing to Flutter article link (#61517) 2020-07-24 15:31:12 -07:00
Dan Field 24f39d40a4 Revert "Revert "Add many more global analyses. (#47875)" (#48080)" (#48081)
This reverts commit 04ea3183ce.
2020-01-02 11:47:28 -08:00
Francisco Magdaleno 04ea3183ce
Revert "Add many more global analyses. (#47875)" (#48080)
This reverts commit e768c92fbc.
2020-01-02 09:25:59 -08:00
Ian Hickson e768c92fbc
Add many more global analyses. (#47875)
* Update packages.

* Add many more global analyses.

* Catch trailing spaces and trailing newlines in all text files.
  Before we were only checking newly added files, but that means we
  missed some.

* Port the trailing spaces logic to work on Windows too.

* Correct all the files with trailing spaces and newlines.

* Refactor some of the dev/bots logic into a utils.dart library.
  Notably, the "exit" and "print" shims for testing are now usable
  from test.dart, analyze.dart, and run_command.dart.

* Add an "exitWithError" function that prints the red lines and
  then exits. This is the preferred way to exit from test.dart,
  analyze.dart, and run_command.dart.

* More consistency in the output of analyze.dart.

* Refactor analyze.dart to use the _allFiles file enumerating logic
  more widely.

* Add some double-checking logic to the _allFiles logic to catch
  cases where changes to that logic end up catching fewer files
  than expected (helps prevent future false positives).

* Add a check to prevent new binary files from being added to
  the repository. Grandfather in the binaries that we've already
  added.

* Update all the dependencies (needed because we now import crypto in
  dev/bots/analyze.dart).
2019-12-30 17:12:19 -08:00
gaaclarke 56e3c0c678
Added note about design doc template. (#43658)
* Added note about design doc template.

* switched "our" to "flutter"

* updated link
2019-10-28 15:58:24 -07:00
Ian Hickson 441b36526d
Update CONTRIBUTING.md (#37645)
* Update CONTRIBUTING.md

* Update CONTRIBUTING.md
2019-08-20 14:44:01 -07:00
Ian Hickson 86dacb200c Update CONTRIBUTING.md (#38491) 2019-08-15 00:07:49 -07:00
Mike Hatch 24a128943d Made a few grammatical changes (#29489) 2019-07-28 12:07:21 -07:00
Tim Sneath 529189791c
Replace flutter.io with flutter.dev (#30562) 2019-04-05 11:39:30 -07:00
Ian Hickson cf2fba7b3b
Reorganize contributor documentation (#23963) 2018-11-06 13:41:09 -08:00
Ian Hickson 2f63044604
[W] Mention new gitter channel (#22974)
* Mention new gitter channel

* Update CONTRIBUTING.md
2018-10-25 15:40:35 -07:00
Alexander Aprelev 391e91c996
Split analysis steps out of dev/bots/test.dart into dev/bots/analyze.dart (#21174)
* Split analysis steps out of dev/bots/test.dart into dev/bots/analyze.dart.

This allows to run analysis step with command line arguments that are only applicable to flutter analyze(like --dart-sdk, needed for dart-flutter-engine head-head-head bot).

* Add forgotten dev/bots/analyze.dart

* Refactor common code from analyze.dart and test.dart into run_command.dart

* Remove comments, add header
2018-08-30 07:30:25 -07:00
Jacob Richman 05b4bd748c Update CONTRIBUTING.md to suggest Android Studio and fix Mac command to install android-platform-tools. (#19537) 2018-08-28 16:22:50 -07:00
Greg Spencer e60087a1a7
Remove Travis configuration from flutter/flutter (#20288)
This removes the final traces of Travis and Appveyor from the Flutter tree.

I've updated the documentation and fixed a couple of places where scripts look for Travis, and eliminated the dart tools runningOnTravis function (which was unused anyhow).

There are places in the flutter script that used to look for the environment variable TRAVIS. We actually do want to continue to detect that we're running on Travis there, since in the plugins repo we still use Travis (for the moment). In any case, it's OK, because the CI environment variable is set on all of the CI bots (Cirrus, Travis, and Appveyor).

FastLane doesn't have a setup_cirrus equivalent to setup_travis, but it actually doesn't matter there either, since it doesn't do Travis-specific things, and it also looks for the CI environment variable.
2018-08-07 13:41:33 -07:00
Ian Hickson 529d250453
Update CONTRIBUTING.md 2018-06-01 12:04:20 -07:00
Mikkel Nygaard Ravn 711174a9b9
Fix inconsistency (#17871) 2018-05-24 17:15:35 +02:00
Devon Carew 09dec7f508
re-write flutter analyze to use the analysis server (#16979)
re-write flutter analyze (the single-shot and --flutter-repo) to use the analysis server
2018-05-10 09:48:40 -07:00
Devon Carew 071485258f
Revert "re-write flutter analyze (the single-shot and --flutter-repo) to use the analysis server (#16281)" (#16482)
This reverts commit 2f41ea546f.
2018-04-11 16:49:38 -07:00
Devon Carew 2f41ea546f
re-write flutter analyze (the single-shot and --flutter-repo) to use the analysis server (#16281)
re-write flutter analyze (the single-shot and --flutter-repo) to use the analysis server
2018-04-11 14:50:36 -07:00
Stanislav Baranov d3abf174be
Removed obsolete step in for rolling a new engine 2018-03-26 13:58:51 -07:00
Yegor e9cf950006
CONTRIBUTING.md: updates for Dart 2; move parts to flutter/engine (#15874)
* CONTRIBUTING.md: updates for Dart 2; move parts to flutter/engine

* address comments
2018-03-23 17:51:41 -07:00
Mikkel Nygaard Ravn 9bc048cb66
Update documentation on how to test flutter_tools (#14567) 2018-02-08 22:15:08 +01:00
Seth Ladd d6dad95842
Point to master API docs (#14292)
* Point to master API docs

I _think_ this is the right place, since people contributing and working on master might care about where the API docs are for master branch.

* Update CONTRIBUTING.md

update from review comment
2018-01-26 16:34:08 -08:00
Leaf Petersen 1dca1b22e8
Remove use of "--assert-initializer" flag from CONTRIBUTING.md (#14032)
* Remove mention of --assert-initializer from CONTRIBUTING.md
* Remove options variable as well
2018-01-11 08:55:14 -08:00
Mat Warger 7bb60f8c61 updated docs to remove note about windows tests not working (#13650)
* updated docs to remove note about windows tests not working

* reverted formatting
2018-01-04 12:37:34 -08:00
Phil Quitslund 82e18827e1
Updated flutter_tools test running instructions. (#13533) 2017-12-14 06:01:28 -08:00
Yegor bf4409f1f3
link from CONTRIBUTING.md to various build infra docs (#13399) 2017-12-06 17:30:44 -08:00
Greg Spencer 797b39e9b2
Creates a new flutter command 'ide-config' and removes *.iml and .idea from tree. (#12958)
Creates a new (hidden) flutter command 'ide-config' that will create and/or update
existing .iml files and some files under the .idea directory, as well as
removing existing *.iml files and the .idea directory.

It also:

 * Adds *.iml to the .gitignore
 * Removes existing .iml files from the repo, and moves them to the
   packages/flutter_tools/ide_templates/intellij directory.
 * Adds a flag to ide-config ('--update-templates') that will take any new .iml
   files in the flutter tree and add them to the existing templates.
     - If --overwrite is also specified, then all existing templates will also
       be overwritten with the contents from the flutter tree, and any that have
       been deleted from the flutter tree will also be removed from the
       templates.
 * Added new run configurations for all existing app targets that will now also
   be automatically added to IntelliJ.
 * Setting up the environment also includes setting the coding style guidelines
   and the git VCS.
 * Note that after this PR lands, Flutter developers will need to run it once to
   re-create the .iml files and configuration files that have been removed.

After this PR lands, .iml files will no longer appear in the untracked files
section for git.
2017-11-13 10:55:22 -08:00
krisgiesing b6185b6668 Fix typos (#12367) 2017-10-05 16:34:16 -07:00
Ian Hickson 36e7138e4f Update some places that mentioned the old update-packages --upgrade (#12218) 2017-09-23 22:23:09 -07:00
Alexander Aprelev 5373a834eb Include instructions to build host configuration for --preview-dart-2. (#11986)
* Include instructions to build host configuration for preview-dart-2

* Space before lparen
2017-09-07 13:13:48 -07:00
Dan Rubel 3a31c35ba0 Rename .analysis_options to analysis_options.yaml (#11594) 2017-08-15 08:46:42 -04:00
Michael Goderbauer 7532a99ce6 Mention alternative way to rebuild flutter tools in CONTRIBUTING.md (#11567) 2017-08-10 08:46:56 -07:00
Jason Simmons 38606a7db6 Update the docs for the flutter_tools tests (#11218) 2017-07-13 17:38:11 -07:00
Ian Hickson be9dd4b28e Remove mention of directly landing on master (#11190)
It's probably too much of a foot gun.

Also, emphasize what you have to do in case people didn't read the design principles document.
2017-07-13 10:23:29 -07:00
Michael Goderbauer 13edb3209d Add Windows support to CONTRIBUTING.md (#10956) 2017-06-26 09:47:05 -07:00
xster 9610ff6b8e Add --start-paused doc (#8233)
* Add --start-paused doc

* correcting > Observatory

* Updating --start-paused option w/feedback
2017-02-17 11:17:05 -08:00
Adam Barth f68343eeec Sync CONTRIBUTING.md text with engine.git (#8004)
* Sync CONTRIBUTING.md text with engine.git

Turns out we had very similar text in engine.git.  This patch makes the text the same by adopting the text in engine.git.

* Update CONTRIBUTING.md
2017-02-08 20:50:29 -08:00
Michael Goderbauer 32271e9f3b Remove deprecated setup.sh and test.sh (#7976) 2017-02-08 13:00:44 -08:00
Adam Barth 428023ceeb Clarify that Atom is needed only for visualizing lcov data (#7973)
Fixes #7119
2017-02-08 10:56:03 -08:00