commonality / generator-community Goto Github PK

💡 TIP: Select the ↖︎⎾ Preview ⏋ Tab above help read these instructions.

1. Issue type

⌦ Type the letter "x" in the "checkbox" the best describe this issue.

• Feature: I'm requesting a product enhancement.

2. User story summary

⌦ Describe what you want to accomplish, in what role/capacity, and why it's important to you.

As a repository maintainer,
I want to stub a CLI
In order to automate features via a Terminal.

3. Acceptance criteria

⌦ Replace the examples below with your own imperative, "true/false" statements for the behavior you expect to see, or the behavior that would be true if there were no errors (for defects).

• 1. All of generator-node/generators/cli's features are available.

💡 TIP: Select the "Preview" Tab to help read these instructions.

1. Issue type

• Feature: I'm requesting an enhancement.

2. User story summary

Describe what you want to accomplish and in what role/capacity, and why it's important to you.

As a product maintainer,
I need to read and write to a product manifest
In order to manage the configuration of my product.

3. Acceptance criteria

ℹ️ Initial MVPs will serialize software configurations with Node.js product manifests, i.e., the package.json file. If a package.json exists, generator-community will only ever add information: generator-community should never replace or overwrite existing data.

📡 Future releases should detect a software product's manifest by language and dependency manager, e.g., Ruby: Gemfile; Java (Gradle): build.gradle; Python: MANIFEST; etc.

• 1. A package.json is created if one doesn't exist already.
• 2. The manifest declares a canonical name for the software product.
• 3. The manifest provides a brief description of the product in order to communicate purpose and value.
• 4. The manifest provides the product's semantic version.
• 5. The manifest provides the primary product author's name, contact url, and contact email.
• 6. The manifest provides an issue tracking URL in case consumers need to report a defect.
• 7. The manifest lists all third-party production dependencies and their semantic versions.
• 8. The manifest lists all third-party development dependencies and their semantic versions.
• 9. The manifest provides the software product's homepage URL.
• 10. The manifest provides a list of keywords that can be used to help classify the software product.
• 11. The manifest provides the URI to the product's primary source code repository.
• 12. The manifest declares the product's open source license.

4. Reference material

• generator-node's app generator has good sample code that reads from and writes to a product's package.json file.
• NPM's package.json documentation describes every property in a Node.js product manifest (the package.json file).

💡 TIP: Select the ↖︎⎾ Preview ⏋ Tab above help read these instructions.

1. Issue type

• Feature: I'm requesting a product enhancement.

2. User story summary

As a consumer or contributor,
I want interactive documentation with RunKit
In order to learn and try using and contributing to generator-community.

3. Acceptance criteria

• 1. Documentation is automatically published whenever changes are merged into master.
• 2. Documentation supports and executes RunKit and Repl.it

Install Airbrake in 2 easy steps:

Step 1: Add the library
Include via CDN:

<script src="https://cdnjs.cloudflare.com/ajax/libs/airbrake-js/1.0.4/client.min.js"></script>

We also support installation via npm and Bower.

Step 2: Copy this config snippet to your app.js file

(You can find your project ID and API KEY with your project's settings):

var airbrake = new airbrakeJs.Client({
  projectId: <Your project ID>,
  projectKey: '<Your project API Key>'
});
airbrake.addFilter(function (notice) {
  notice.context.environment = 'production';
  return notice;
});

To test that Airbrake has been installed correctly in your JavaScript project, just open up the JavaScript console in your internet browser and paste in:

airbrake.notify('hey there!')

Visit official GitHub repo for more info on alternative configurations and advanced options.

1. Issue type

⌦ Type the letter "x" in the "checkbox" the best describe this issue.

• Feature: I'm requesting a product enhancement.

2. User story summary

As a repository maintainer,
I need to have a CONTRIBUTING.md document
In order to assist those who want to contribute.

3. Acceptance criteria

• 1. Maintainers are prompted for their Git branching workflow (feature-branch, Gitflow, or "other")
• 2. Maintainers are prompted for a URL to their code standards and name (if applicable).
• 3. Maintainers are prompted for the name and URL to their linter.
• 4. Maintainers are prompted for their unit testing framework name and URL.
• 5. Maintainers are prompted for their unit testing Statement, Branch, Method, and Line coverage thresholds.
• 6. Maintainers are prompted for the name of their Logging library and its URL.
• 7. Maintainers are prompted for their conventional commit message style (jQuery or Angular).
• 8. Maintainers are prompted for their product's programing language.
• 9. Maintainers are prompted for their product's dependency manager.
• 10. Maintainers are prompted for the path to their product manifest.
• 11. Maintainers are asked whether to include a section for RESTful APIs.
• 12. A CONTRIBUTING.md document is generated based on the answers provided.
• 13. The README.md document has been updated to reflect new features.

TIP: Select the "Preview" Tab to help read these instructions.

1. Issue type

• Feature: I'm requesting an enhancement.

2. User story summary

As an open source product maintainer,
I need a consistent and succinct README file
In order to encourage consumption of my product.

3. Acceptance criteria

Replace the examples below with your own imperative, "true/false" statements for the behavior you expect to see, or the behavior that would be true if there were no errors (for defects).

• 1. Generated READMEs display a title that defaults to the package.json/#/name property.
  - [ ] 2. Generated READMEs display an option logoPath under the title.
• 3. Generated READMEs display an optional section for badges.
• 4. Generated READMEs display a required short description section.
• 5. Generated READMEs provide an optional Overview section.
• 6. Generated READMEs provide a Table of contents section with anchor links that jump to subsequent sections.
• 7. Generated READMEs display a required Installation section with default Node.js installation instructions.
• 8. Generated READMEs provide an optional Configuration section.
• 9. Generated READMEs display a required Usage section.
• 10. Generated READMEs provide an optional API section.
• 11. Generated READMEs provide an optional Background section.
• 12. Generated READMEs provide an optional Security section.
• 13. Generated READMEs display a Contributing section.
• 13.1. The Contributing section provides a working link to a CODE_OF_CONDUCT document.
• 13.2. The Contributing section provides a working link to a CONTRIBUTING document.
• 13.3. The Contributing section provides a link that will pre-populate a new GitHub feature request.
• 13.4. The Contributing section provides a link that will pre-populate a new GitHub defect report.
• 14. Generated READMEs display a License section with a working links to the OSS license and its copyright owner.

Notes

There are several README generators available on the npm registry today. Evaluate:

• 1. generator-standard-readme - Opinionated, but pretty good. Richard Littauer has even declared it a "specification."
• 2. generator-readme
• 3. generator-make-readme is a fork of generator-standard-readme, and it looks pretty good.
• 4. generator-badges add badges. I'll probably incorporate this.
• 5. generator-verb looks good, but it hasn't been touched in a long time.

1. Issue type

⌦ Type the letter "x" in the "checkbox" the best describe this issue.

• Feature: I'm requesting a product enhancement.

2. User story summary

⌦ Describe what you want to accomplish, in what role/capacity, and why it's important to you.

As a repository maintainer,
I need to generate a code of conduct
In order to declare acceptable and unacceptable behavior to (potential) contributors.

3. Acceptance criterion

• 1. A CODE_OF_CONDUCT.md file based on the Contributor Covenant, version 1.4, exists.
• 2. The CODE_OF_CONDUCT.md includes a team contact email link.

1. Issue type

⌦ Type the letter "x" in the "checkbox" the best describe this issue.

• Feature: I'm requesting a product enhancement.

2. User story summary

⌦ Describe what you want to accomplish, in what role/capacity, and why it's important to you.

EXAMPLE:
As a Applicant,
I want to submit my resume
In order to be considered for a job opening.

As a {role},
I must/need/want/should {do something}
In order to {achieve value}.

3. Acceptance criteria

⌦ Replace the examples below with your own imperative, "true/false" statements for the behavior you expect to see, or the behavior that would be true if there were no errors (for defects).

• 1. Job Applicants receive a confirmation email after they submit their resumes.
• 2. An Applicant's resume information isn't lost when errors occur.
• 3. {criterion-three}
• 4. {criterion-four}

🐞 4. Steps to reproduce (for defects only)

⌦ Provide a link to a live example, or
⌦ Replace the examples below with an unambiguous sequence of instructions that end with proof of the defect.
⌦ Include source code and log files, if relevant and available.

1. Enter the words "...." into the "Search" text field.
2. Select the Search button.
3. Next...
4. Then...
5. Finally...
6. X does not work as expected.

🐞 5. Your environment (for defects only)

⌦ Include as many relevant details about the environment in which the defect occured.

• Version of generator-community:
• Environment name and version (e.g. Chrome 39, node.js 5.4):
• Operating System and version (desktop or mobile):
• Link to your project:

💡 TIP: Select the "Preview" Tab to help read these instructions.

1. Issue type

• Feature: I'm requesting an enhancement.

2. User story summary

Describe what you want to accomplish and in what role/capacity, and why it's important to you.

As a product owner,
I must include an open source license
In order to make my software product open source.

3. Acceptance criteria

• 1. generator-community is composed with generator-license.
• 2. yo community invokes generator-license.
• 3. the community:license subgenerator invokes generator-license using the same CLI signature and arguments as generator-license.

4. Reference material

generator-node's app generator has good sample code that invokes generator-license.

1. Issue type

⌦ Type the letter "x" in the "checkbox" the best describe this issue.

• Feature: I'm requesting a product enhancement.

2. User story summary

⌦ Describe what you want to accomplish, in what role/capacity, and why it's important to you.

EXAMPLE:
As a Applicant,
I want to submit my resume
In order to be considered for a job opening.

As a {role},
I must/need/want/should {do something}
In order to {achieve value}.

3. Acceptance criteria

⌦ Replace the examples below with your own imperative, "true/false" statements for the behavior you expect to see, or the behavior that would be true if there were no errors (for defects).

• 1. Job Applicants receive a confirmation email after they submit their resumes.
• 2. An Applicant's resume information isn't lost when errors occur.
• 3. {criterion-three}
• 4. {criterion-four}

🐞 4. Steps to reproduce (for defects only)

⌦ Provide a link to a live example, or
⌦ Replace the examples below with an unambiguous sequence of instructions that end with proof of the defect.
⌦ Include source code and log files, if relevant and available.

1. Enter the words "...." into the "Search" text field.
2. Select the Search button.
3. Next...
4. Then...
5. Finally...
6. X does not work as expected.

🐞 5. Your environment (for defects only)

⌦ Include as many relevant details about the environment in which the defect occured.

• Version of generator-community:
• Environment name and version (e.g. Chrome 39, node.js 5.4):
• Operating System and version (desktop or mobile):
• Link to your project: