commonality / readme-inspector Goto Github PK

1. User story summary

As a repository owner or maintainer,
I want to ensure my product has a well-written README on my Bitbucket repository root
In order to introduce potential consumers to my product.

2. Acceptance criteria

When given the URL to a repository,

• 1. The presence of a README is declared.
• 2. The absence of README is declared.
• 3. READMEs are scored according to the readme-score-api (as used by the CoCoPods registry.)

3. Notes

• readmeInfo.isPresent:

  HTTP:

  HEAD /1.0/repositories/gregswindle/generator-bitbucket/raw/master/README.md HTTP/1.1
  Host: api.bitbucket.org

  cURL:

  curl -X HEAD \
  https://api.bitbucket.org/1.0/repositories/gregswindle/generator-bitbucket/raw/master/README.md \
  -H 'Cache-Control: no-cache' \

• Example:

  URL:

  https://api.bitbucket.org/1.0/repositories/gregswindle/generator-bitbucket/raw/master/README.md

See: what is the v2 API to get file content?. (2016). Atlassian Community. Retrieved 21 April 2018, from https://community.atlassian.com/t5/Answers-Developer-Questions/what-is-the-v2-API-to-get-file-content/qaq-p/574065

3.2. Node.js API clients

These modules might help.

1. hosted-git-info
2. bitbucketjs Too bloated for too little.
3. got🌟

3.3. README info

This endpoints is used to retrieve the contents of a single file, or the contents of a directory at a specified revision.

Raw file contents

When path points to a file, this endpoint returns the raw contents. The response's Content-Type is derived from the filename extension (not from the contents). The file contents are not processed and no character encoding/recoding is performed and as a result no character encoding is included as part of the Content-Type.

REST - Atlassian Documentation. (2018). Developer.atlassian.com. Retrieved 21 April 2018, from https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/src/%7Bnode%7D/%7Bpath%7D

1. User story summary

As a contributor,
I want to formally propose and decide on architecturally significant choices
In order to facilitate orderly change.

2. Acceptance criteria

• The phodal/adr library--and its npm-scripts--are executable with this module.

The devDependency eslint-plugin-prettier was updated from 2.6.2 to 2.7.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-prettier is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

1. User story summary

As a consultant helping researchers publish their codes,
I want to find this repo under a topic that similar projects also use
In order to point people to the topic page rather than to a list of individual repos.

2. Acceptance criteria

• 1. this repo shows up on GitHub.com/topics/documentation-quality

1. User story summary

As a repository owner or maintainer,
I want to ensure my product has a well-written README
In order to introduce potential consumers to my product.

2. Acceptance criteria

When given the URL to a repository,

• 1. The presence of a README is declared.
• 2. The absence of README is declared.
• 3. READMEs are scored according to the readme-score-api (as used by the CoCoPods registry).
• 4. Configuration variables are separated from source code with environment (env) variables.

1. User story summary

As a consumer,
I want to inspect and assess READMEs without unnecessary configuration
In order to simplify usage.

2. Acceptance criteria

• 1. The CHANGELOG.md reflects fixes.
• 2. zip and tar.gz bundles are available in GitHub Releases.
• 3. v1.0.1 is the latest dist-tag available from NPM.
• 4. The README and CONTRIBUTING docs reflect all changes.
• 5. The product's semantic version reflects v1.0.1 in the manifest and all documents.

1. User story summary

As a maintainer,
I want to integrate Travis-CI with the commonality workspace channel #readme-inspector,
In order to receive build and PR notifications.

2. Acceptance criteria

• 1. The Travis CI slack app is installed in the commonality workspace.
• 2. The [commonality/readme-inspector] repository's .travis.yml is configured to send notifications to the #readme-inspector channel.
• 3. The integration credentials are encrypted with the Travis command line client.
• 4. The app is named "Travis CI" and it uses the default Travis CI icon .
• 5. The Travis CI Slack configuration URL is published in this repository.
• 6. The Travis CI slack app receives notifications from Travis CI.
• 7. ReadmeScore.for initializes the ?url= search parameter correctly.

1. User story summary

As a consumer,
I need to initialize configuration variables
In order to maintain a decoupled, 12-factor app.

2. Acceptance criteria

When readme-inspector loads:

• 1. All .env variables are in .env.schema are defined.

• 2. All values defined in .env.defaults initialize process.env.CONSTANT_NAME.

• 3. All key/value pairs in .env override all other files, and are available via process.env as well as envConfig, where

  const dotenvExtended = require('dotenv-extended')
  const envConfig = dotenvExtended.load()

🐞 3. Steps to reproduce (for defects only)

1. Install v2.0.0 of readme-inspector, e.g.,

   $ npm i -g readme-inspector

2. Launch the Node.js REPL, import/require readme-inspector, and verify that API_ENDPOINT_README_SCORE has been initialized:

   $ node
   > const inspector = require('readme-inspector')
   > process.env.API_ENDPOINT_README_SCORE
   undefined
   >

3. You will see the value

   undefined

   instead of the expected value

   'http://readme-score-api.herokuapp.com/score.json?url=&human_breakdown=false&force=false'

🐞 4. Your environment (for defects only)

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

Operating System and version (desktop or mobile)

Hardware:

    Hardware Overview:

      Model Name: MacBook Pro
      Model Identifier: MacBookPro11,4
      Processor Name: Intel Core i7
      Processor Speed: 2.8 GHz
      Number of Processors: 1
      Total Number of Cores: 4
      L2 Cache (per Core): 256 KB
      L3 Cache: 6 MB
      Memory: 16 GB
      Boot ROM Version: MBP114.0182.B00
      SMC Version (system): 2.29f24

Software:

    System Software Overview:

      System Version: macOS 10.12.6 (16G1314)
      Kernel Version: Darwin 16.7.0
      Time since boot: 7 days 22:39

1. User story: summary of expected behavior

As a consumer,
I want an .env.schema to declare required variables initialized with default values (where possible)
In order to avoid errors.

2. Acceptance criteria

• 1. A .env.schema exists with env variable declarations.
• 2. Optional vars load by default from env.defaults.
• 3. Required vars do not unless they're part of the session.

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

1. User story summary

As a consumer,
I would like to know that readme-inspector follows the voluntarily, self-certified Core Infrastructure Initiative (CII)
In order to feel confident about product quality.

2. Acceptance criteria

The following OWASP dependency-checks are sufficiently addressed:

• 1. Basics 12/12
• 2. Change Control 9/9
• 3. Reporting 8/8
• 4. Quality 13/13
• 5. Security 16/16
• 6. Analysis 8/8
• 7. The README displays a CII Best Practices Badge with a link to the self-certificated questions and answers.