From 81b7a39edcbb130b107badb1fbe74c2b8fd52cc2 Mon Sep 17 00:00:00 2001 From: Alexander Makarov <sam@rmcreative.ru> Date: Sun, 12 Jan 2014 20:56:53 +0400 Subject: [PATCH] fixes #1674: Updated contributing docs --- CONTRIBUTING.md | 16 +++------------- docs/internals/ar.md | 32 -------------------------------- docs/internals/getting-started.md | 5 ++++- docs/internals/report-an-issue.md | 14 ++++++++++++++ 4 files changed, 21 insertions(+), 46 deletions(-) delete mode 100644 docs/internals/ar.md create mode 100644 docs/internals/report-an-issue.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fac038..cb5af64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,6 @@ Contributing to Yii2 ==================== -Creating issues ---------------- - -- Please use English if possible. -- Make sure it is clear how to reproduce it. -- Make sure it is clear why you think it is necessary to fix. - -Contributing to the core framwork and official extensions ---------------------------------------------------------- - -- [Getting started with Yii2 development](docs/internals/getting-started.md) -- [Git workflow for Yii 2 contributors](docs/internals/git-workflow.md) -- [Translation workflow](docs/internals/translations.md) +- [Report an issue](docs/internals/report-an-issue.md) +- [Traslate documentation or messages](docs/internals/translations.md) +- [Contribute to the core code or fix bugs](docs/internals/getting-started.md) \ No newline at end of file diff --git a/docs/internals/ar.md b/docs/internals/ar.md deleted file mode 100644 index d186939..0000000 --- a/docs/internals/ar.md +++ /dev/null @@ -1,32 +0,0 @@ -ActiveRecord -============ - -Scenarios ---------- - -Possible scenario formats supported by ActiveRecord: - -```php -public function scenarios() -{ - return [ - // attributes array, all operations won't be wrapped with transaction - 'scenario1' => ['attribute1', 'attribute2'], - - // insert and update operations will be wrapped with transaction, delete won't be wrapped - 'scenario2' => [ - 'attributes' => ['attribute1', 'attribute2'], - 'atomic' => [self::OP_INSERT, self::OP_UPDATE], - ], - ]; -} -``` - -Query ------ - -### Basic Queries - -### Relational Queries - -### Scopes diff --git a/docs/internals/getting-started.md b/docs/internals/getting-started.md index e8f2430..b05ba25 100644 --- a/docs/internals/getting-started.md +++ b/docs/internals/getting-started.md @@ -29,4 +29,7 @@ If you're not core developer or want to use your own fork for pull requests: url = git://github.com/username/yii2.git ``` -> Hint: The workflow of forking a package and pushing changes back into your fork and then sending a pull-request to the maintainer is the same for all extensions you require via composer. +> Hint: The workflow of forking a package and pushing changes back into your fork and then sending a pull-request to the + maintainer is the same for all extensions you require via composer. + +Please refer to [Git workflow for Yii 2 contributors](git-workflow.md) for details about creating pull requests. \ No newline at end of file diff --git a/docs/internals/report-an-issue.md b/docs/internals/report-an-issue.md new file mode 100644 index 0000000..a41153a --- /dev/null +++ b/docs/internals/report-an-issue.md @@ -0,0 +1,14 @@ +Creating issues +=============== + +You got into rough corner while working with yii, or you found a bug? We are very sorry for that, but we can sort that +out together. + +- If you are unsure about a function, you may ask on IRC or the forums. If the documentation is unclear, open a separate + issue. +- Please use English if possible. +- Make sure it is clear what is the problem and how to reproduce it. + +If you are going to report security issue please **do not** use the issue tracker and instead +[contact us directly](http://www.yiiframework.com/security/). + -- libgit2 0.27.1