Missing readme file [#2878963]

Hi team,

I add README.md file for this module since this is required for security advisory coverage process: https://www.drupal.org/node/539608
https://www.drupal.org/node/1587704

Comment	File	Size	Author
#15	interdiff.txt	2.33 KB	MegaChriz
#12	feeds_tamper-add_readme-2878963-12.patch	2.17 KB	nileema.jadhav
#12	8.x-2.x: PHP 5.5 & MySQL 5.5, D8.6 29 pass
#7	feeds_tamper-add_readme-2878963-6.patch	1.86 KB	dhruveshdtripathi
#7	7.x-1.x: PHP 5.3 & MySQL 5.5, D7 Unable to generate test groups PHP 5.6 & MySQL 5.5, D7 86 pass PHP 7.1 & MySQL 5.5, D7 86 pass PHP 7 & MySQL 5.5, D7 86 pass
#5	feeds_tamper-add_readme-2878963-5.patch	1.5 KB	firfin
#5	7.x-1.x: PHP 5.3 & MySQL 5.5, D7 Unable to generate test groups PHP 5.6 & MySQL 5.5, D7 86 pass PHP 7 & MySQL 5.5, D7 86 pass
#2	feeds-tamper-add-readme-2878963-2.patch	1.63 KB	sakural
#2	7.x-1.x: PHP 5.3 & MySQL 5.5, D7 78 pass

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

17 May 2017 at 02:37

sakural created an issue. See original summary.

Comment #2

sakural CreditAttribution: sakural as a volunteer commented 17 May 2017 at 02:40

File	Size
feeds-tamper-add-readme-2878963-2.patch	1.63 KB
7.x-1.x: PHP 5.3 & MySQL 5.5, D7 78 pass

Comment #3

jackenmail

English

CreditAttribution: jackenmail commented 17 May 2017 at 06:27

Status:

Needs review

» Reviewed & tested by the community

Hi All,

I have tested this patch and its working properly.

Thanks,

Comment #4

MegaChriz CreditAttribution: MegaChriz as a volunteer commented 29 May 2017 at 07:46

Status:

Reviewed & tested by the community

» Needs work

+++ b/README.md
@@ -0,0 +1,57 @@
+ * Depends on `Feeds` (>=beta-10).

This line applies to the D6 version of Feeds. Should be removed.

+++ b/README.md
@@ -0,0 +1,57 @@
+UPGRADE NOTES
+-------------
+
+ * If you're upgrading from <= alpha3, the module must be UNINSTALLED first.

This applies to the D6 version of Feeds Tamper. There is no alpha3 version for Feeds Tamper 7.x-1.x.
Should be removed.

Comment #5

firfin CreditAttribution: firfin commented 21 February 2018 at 19:31

Status:

Needs work

» Needs review

File	Size
feeds_tamper-add_readme-2878963-5.patch	1.5 KB
7.x-1.x: PHP 5.3 & MySQL 5.5, D7 Unable to generate test groups PHP 5.6 & MySQL 5.5, D7 86 pass PHP 7 & MySQL 5.5, D7 86 pass

1 file was hidden/shown/deleted

File	Size
feeds-tamper-add-readme-2878963-2.patch	1.63 KB
7.x-1.x: PHP 5.3 & MySQL 5.5, D7 78 pass

Updated the patch from #2 according to the comments in #4. Also fixed some grammar / spelling.

Comment #6

21 February 2018 at 19:33

Status:

Needs review

» Needs work

The last submitted patch, 5: feeds_tamper-add_readme-2878963-5.patch, failed testing. View results

Comment #7

dhruveshdtripathi CreditAttribution: dhruveshdtripathi at DevsAdda commented 22 February 2018 at 07:03

Status:

Needs work

» Needs review

File	Size
feeds_tamper-add_readme-2878963-6.patch	1.86 KB
7.x-1.x: PHP 5.3 & MySQL 5.5, D7 Unable to generate test groups PHP 5.6 & MySQL 5.5, D7 86 pass PHP 7.1 & MySQL 5.5, D7 86 pass PHP 7 & MySQL 5.5, D7 86 pass

Updated patch with README template (https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...)

Comment #8

22 February 2018 at 07:10

Status:

Needs review

» Needs work

The last submitted patch, 7: feeds_tamper-add_readme-2878963-6.patch, failed testing. View results

Comment #9

firfin CreditAttribution: firfin commented 22 February 2018 at 10:34

1 file was hidden/shown/deleted

File	Size
feeds_tamper-add_readme-2878963-5.patch	1.5 KB
7.x-1.x: PHP 5.3 & MySQL 5.5, D7 Unable to generate test groups PHP 5.6 & MySQL 5.5, D7 86 pass PHP 7 & MySQL 5.5, D7 86 pass

Testing fails because CTools is using short array syntax and we are using tests with php 5.3 . Changed the php version used for testing.

Comment #10

firfin CreditAttribution: firfin commented 22 February 2018 at 10:34

Status:

Needs work

» Needs review

Comment #11

MegaChriz CreditAttribution: MegaChriz as a volunteer commented 1 March 2018 at 20:13

Status:

Needs review

» Needs work

Quick review:

+++ b/README.md
@@ -0,0 +1,69 @@
+Feeds Tamper can be installed like any other Drupal module

Missing dot at the end of the sentence.

```
+++ b/README.md
@@ -0,0 +1,69 @@
+Your can add tampers on the TAMPER tab while editing your Feeds importer.
```
"Your can add tampers" doesn't sound like proper English. I'm also not sure why "TAMPER" should be all caps. This should probably be rephrased a bit. Explain how to get to Tamper configuration, how adding Tampers work and that they can be rearranged.

+++ b/README.md
@@ -0,0 +1,69 @@
+Check out the documentation (https://www.drupal.org/node/1246562). It needs
+help!

It's probably enough to just link to the documentation.

```
+++ b/README.md
@@ -0,0 +1,69 @@
+Current maintainers:
+ * Chris Leppanen (twistor) - https://www.drupal.org/u/twistor
+ * Youri van Koppen (MegaChriz) - https://www.drupal.org/u/megachriz
```
Neither I nor Chris are currently actively maintaining the D7 version of this module (you could say though that I’m passively maintaining it). I'm mainly working on the D8 version. Not sure how to rephrase that, but "Current" seems a bit out of place.

Comment #12

nileema.jadhav CreditAttribution: nileema.jadhav as a volunteer and at TATA Consultancy Services for Pfizer, Inc. commented 29 August 2018 at 07:37

File	Size
feeds_tamper-add_readme-2878963-12.patch	2.17 KB
8.x-2.x: PHP 5.5 & MySQL 5.5, D8.6 29 pass

Worked on @dhruveshdtripathi 's patch to incorporate @MegaChriz 's comments

Comment #13

nileema.jadhav CreditAttribution: nileema.jadhav as a volunteer and at TATA Consultancy Services for Pfizer, Inc. commented 29 August 2018 at 13:27

Status:

Needs work

» Needs review

Comment #14

23 September 2018 at 12:23

MegaChriz committed 7d44470 on 7.x-1.x authored by nileema.jadhav

Issue #2878963 by sakural, firfin, nileema.jadhav, dhruveshdtripathi,...

Comment #15

MegaChriz CreditAttribution: MegaChriz as a volunteer commented 23 September 2018 at 12:24

Status:

Needs review

» Fixed

File	Size
interdiff.txt	2.33 KB

I made a few changes to the readme and committed the result.

Changes:

In 'Introduction' links are added to the plugin list, the contributed plugin list and a page that explains how to develop your own plugin.
In 'Installation', it is mentioned that Feeds Tamper Admin UI needs to be enabled in order to configure tampers in the UI.
In 'Configuration' the two paragraphs are flipped.
A few changes in the formatting (extra new lines and making sure that all lines fit on 80 chars).