✨Ask user for a link to contributing guide (fixes #168)

src/__snapshots__/readme.spec.js.snap

@@ -62,7 +62,7 @@ npm run test
 
 ## 🤝 Contributing
 
-Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/kefranabg/readme-md-generator/issues).
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/kefranabg/readme-md-generator/issues). You can also take a look at the [contributing guide](https://github.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md).
 
 ## Show your support
 
@@ -133,7 +133,7 @@ npm run test
 
 Contributions, issues and feature requests are welcome!
 
-Feel free to check [issues page](https://github.com/kefranabg/readme-md-generator/issues).
+Feel free to check [issues page](https://github.com/kefranabg/readme-md-generator/issues). You can also take a look at the [contributing guide](https://github.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md).
 
 ## Show your support
 

src/project-infos.js

@@ -99,6 +99,9 @@ const getLicenseUrlFromGithubRepositoryUrl = repositoryUrl =>
 const getReadmeUrlFromGithubRepositoryUrl = repositoryUrl =>
   `${repositoryUrl}#readme`
 
+const getContributingUrlFromRepositoryUrl = repositoryUrl =>
+  `${repositoryUrl}/blob/master/CONTRIBUTING.md`
+
 /**
  * Get project author name from package.json
  *
@@ -137,8 +140,11 @@ const getProjectInfos = async () => {
     ? 'npm run test'
     : undefined
   const repositoryUrl = await getReposUrl(packageJson)
-  const contributingUrl = await getReposIssuesUrl(packageJson)
+  const issuesUrl = await getReposIssuesUrl(packageJson)
   const isGithubRepos = isGithubRepository(repositoryUrl)
+  const contributingUrl = repositoryUrl
+    ? getContributingUrlFromRepositoryUrl(repositoryUrl)
+    : undefined
   const documentationUrl = isGithubRepos
     ? getReadmeUrlFromGithubRepositoryUrl(repositoryUrl)
     : undefined
@@ -162,6 +168,7 @@ const getProjectInfos = async () => {
     authorWebsite,
     homepage,
     repositoryUrl,
+    issuesUrl,
     contributingUrl,
     githubUsername,
     engines,

src/project-infos.spec.js

@@ -70,7 +70,7 @@ describe('projectInfos', () => {
         repositoryUrl: 'https://github.com/kefranabg/readme-md-generator',
         homepage: 'https://github.com/kefranabg/readme-md-generator',
         contributingUrl:
-          'https://github.com/kefranabg/readme-md-generator/issues',
+          'https://github.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md',
         authorWebsite: 'https://www.franck-abgrall.me/',
         githubUsername: 'kefranabg',
         engines: {
@@ -84,6 +84,7 @@ describe('projectInfos', () => {
           'https://github.com/kefranabg/readme-md-generator#readme',
         isGithubRepos: true,
         isJSProject: true,
+        issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
         usage: undefined,
         testCommand: undefined
       })
@@ -123,7 +124,7 @@ describe('projectInfos', () => {
         author: 'Franck Abgrall',
         repositoryUrl: 'https://gitlab.com/kefranabg/readme-md-generator',
         contributingUrl:
-          'https://gitlab.com/kefranabg/readme-md-generator/issues',
+          'https://gitlab.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md',
         homepage: 'https://gitlab.com/kefranabg/readme-md-generator',
         githubUsername: undefined,
         authorWebsite: undefined,
@@ -136,6 +137,7 @@ describe('projectInfos', () => {
         documentationUrl: undefined,
         isGithubRepos: false,
         isJSProject: true,
+        issuesUrl: 'https://gitlab.com/kefranabg/readme-md-generator/issues',
         usage: undefined,
         testCommand: undefined
       })
@@ -156,7 +158,7 @@ describe('projectInfos', () => {
         author: undefined,
         repositoryUrl: 'https://github.com/kefranabg/readme-md-generator',
         contributingUrl:
-          'https://github.com/kefranabg/readme-md-generator/issues',
+          'https://github.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md',
         homepage: undefined,
         githubUsername: 'kefranabg',
         authorWebsite: 'https://www.franck-abgrall.me/',
@@ -168,6 +170,7 @@ describe('projectInfos', () => {
           'https://github.com/kefranabg/readme-md-generator#readme',
         isGithubRepos: true,
         isJSProject: false,
+        issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
         usage: undefined,
         testCommand: undefined
       })
@@ -187,8 +190,9 @@ describe('projectInfos', () => {
         version: undefined,
         author: undefined,
         repositoryUrl: 'https://gitlab.com/kefranabg/readme-md-generator',
+        authorWebsite: undefined,
         contributingUrl:
-          'https://gitlab.com/kefranabg/readme-md-generator/issues',
+          'https://gitlab.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md',
         homepage: undefined,
         githubUsername: undefined,
         engines: undefined,
@@ -197,6 +201,7 @@ describe('projectInfos', () => {
         documentationUrl: undefined,
         isGithubRepos: false,
         isJSProject: false,
+        issuesUrl: 'https://gitlab.com/kefranabg/readme-md-generator/issues',
         usage: undefined,
         testCommand: undefined
       })
@@ -265,7 +270,7 @@ describe('projectInfos', () => {
         author: 'Franck Abgrall',
         repositoryUrl: 'https://github.com/kefranabg/readme-md-generator',
         contributingUrl:
-          'https://github.com/kefranabg/readme-md-generator/issues',
+          'https://github.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md',
         homepage: 'https://github.com/kefranabg/readme-md-generator',
         githubUsername: 'kefranabg',
         authorWebsite: 'https://www.franck-abgrall.me/',
@@ -280,6 +285,7 @@ describe('projectInfos', () => {
           'https://github.com/kefranabg/readme-md-generator#readme',
         isGithubRepos: true,
         isJSProject: true,
+        issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
         usage: undefined,
         testCommand: undefined
       })
@@ -324,7 +330,7 @@ describe('projectInfos', () => {
         repositoryUrl: 'https://github.com/kefranabg/readme-md-generator',
         homepage: 'https://github.com/kefranabg/readme-md-generator',
         contributingUrl:
-          'https://github.com/kefranabg/readme-md-generator/issues',
+          'https://github.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md',
         githubUsername: 'kefranabg',
         authorWebsite: 'https://www.franck-abgrall.me/',
         engines: {
@@ -338,6 +344,7 @@ describe('projectInfos', () => {
           'https://github.com/kefranabg/readme-md-generator#readme',
         isGithubRepos: true,
         isJSProject: true,
+        issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
         usage: undefined,
         testCommand: undefined
       })

src/questions/contributing-url.js

@@ -0,0 +1,6 @@
+module.exports = projectInfos => ({
+  type: 'input',
+  message: '🤝  Contributing guide url (use empty value to skip)',
+  name: 'contributingUrl',
+  default: projectInfos.contributingUrl
+})

src/questions/contributing-url.spec.js

@@ -0,0 +1,18 @@
+const askContributingUrl = require('./contributing-url')
+
+describe('askContributingUrl', () => {
+  it('should return correct question format', () => {
+    const contributingUrl =
+      'https://github.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md'
+    const projectInfos = { contributingUrl }
+
+    const result = askContributingUrl(projectInfos)
+
+    expect(result).toEqual({
+      type: 'input',
+      message: '🤝  Contributing guide url (use empty value to skip)',
+      name: 'contributingUrl',
+      default: contributingUrl
+    })
+  })
+})

src/questions/index.js

@@ -15,7 +15,8 @@ module.exports = {
   askProjectPrerequisites: require('./project-prerequisites'),
   askLicenseName: require('./license-name'),
   askLicenseUrl: require('./license-url'),
-  askContributing: require('./contributing'),
+  askIssuesUrl: require('./issues-url'),
+  askContributingUrl: require('./contributing-url'),
   askInstallCommand: require('./install-command'),
   askUsage: require('./usage'),
   askTestCommand: require('./test-command')

src/questions/index.spec.js

@@ -20,7 +20,8 @@ describe('questions', () => {
       'askProjectPrerequisites',
       'askLicenseName',
       'askLicenseUrl',
-      'askContributing',
+      'askIssuesUrl',
+      'askContributingUrl',
       'askInstallCommand',
       'askUsage',
       'askTestCommand'

src/questions/contributing.js → src/questions/issues-url.js

@@ -1,6 +1,6 @@
 module.exports = packageJson => ({
   type: 'input',
   message: '🔧  Issues page url (use empty value to skip)',
-  name: 'contributingUrl',
-  default: packageJson.contributingUrl
+  name: 'issuesUrl',
+  default: packageJson.issuesUrl
 })

src/questions/issues-url.spec.js

@@ -0,0 +1,17 @@
+const askIssues = require('./issues-url')
+
+describe('askIssues', () => {
+  it('should return correct question format', () => {
+    const issuesUrl = 'https://github.com/kefranabg/readme-md-generator/issues'
+    const projectInfos = { issuesUrl }
+
+    const result = askIssues(projectInfos)
+
+    expect(result).toEqual({
+      type: 'input',
+      message: '🔧  Issues page url (use empty value to skip)',
+      name: 'issuesUrl',
+      default: issuesUrl
+    })
+  })
+})

src/readme.spec.js

@@ -102,8 +102,9 @@ describe('readme', () => {
       licenseName: 'MIT',
       licenseUrl:
         'https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE',
+      issuesUrl: 'https://github.com/kefranabg/readme-md-generator/issues',
       contributingUrl:
-        'https://github.com/kefranabg/readme-md-generator/issues',
+        'https://github.com/kefranabg/readme-md-generator/blob/master/CONTRIBUTING.md',
       installCommand: 'npm install',
       usage: 'npm start',
       testCommand: 'npm run test',

templates/default-no-html.md

@@ -85,13 +85,13 @@
 * LinkedIn: [@<%= authorLinkedInUsername %>](https://linkedin.com/in/<%= authorLinkedInUsername %>)
 <% } -%>
 <% } -%>
-<% if (contributingUrl) { -%>
+<% if (issuesUrl) { -%>
 
 ## 🤝 Contributing
 
 Contributions, issues and feature requests are welcome!
 
-Feel free to check [issues page](<%= contributingUrl %>).
+Feel free to check [issues page](<%= issuesUrl %>). <%= contributingUrl ? `You can also take a look at the [contributing guide](${contributingUrl}).` : '' %>
 <% } -%>
 
 ## Show your support

templates/default.md

@@ -97,11 +97,11 @@
 * LinkedIn: [@<%= authorLinkedInUsername %>](https://linkedin.com/in/<%= authorLinkedInUsername %>)
 <% } -%>
 <% } -%>
-<% if (contributingUrl) { -%>
+<% if (issuesUrl) { -%>
 
 ## 🤝 Contributing
 
-Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](<%= contributingUrl %>).
+Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](<%= issuesUrl %>). <%= contributingUrl ? `You can also take a look at the [contributing guide](${contributingUrl}).` : '' %>
 <% } -%>
 
 ## Show your support