mntnr / build-a-space Goto Github PK
View Code? Open in Web Editor NEWAutomatically add community documentation to your repository
Home Page: https://maintainer.io
License: MIT License
Automatically add community documentation to your repository
Home Page: https://maintainer.io
License: MIT License
Right now, the README just says "It does a lot of stuff".
Dearest humans,
I've run into a problem here. I am trying to update the community docs and to get this repo up-to-scratch. I would usually create a new pull request to let you know about it, or update an existing one. But now there more than one: #23, #22
I don’t know how that happened, did I short-circuit again?
You could really help me by closing all pull requests or leave the one open you want me to keep updating.
Hope you can fix it (and my circuits) soon 🙏
The question here is: who should be sending this PR? Me, or a bot?
Might be best to make a GitHub bot for this.
Should be simple.
This is how we ought to be able to specify special files.
Suggest another one, preferable from a manifest (see #42).
The dist.ini file can have License information that the repository might not have. https://github.com/shutterstock/Net-Statsd-Client/blob/master/dist.ini
Either intelligently add to it, or ignore.
bugs
matches GitHub URLI want to be able to grab the Contribute/ing section from a README and use that to stub out the Contribute document.
@wooorm is there an easy way to grab a section using remark?
- [Open an issue!](https://github.com/<REPONAME>/issues/new)
You'll need to replace this in the fixture before putting it in the output.
This is the one I've always leaned on:
https://cookiecutter.readthedocs.io/en/latest/
I wonder whether build-a-space
could simply be pointed to one of many cookiecutter template repos, and apply the results via PR...
From CLI, cookiecutter's config wizard is intended to be kickstarted like:
$ cookiecutter gh:infOpen/cookiecutter-ansible-role
The @todogroup has a similar tool, https://github.com/todogroup/repolinter. Ideally, these should work together. It would be great if we could find a way to integrate them.
Because?
Take a look at @gr2m's work.
Because!
Failed to find command after npm i -g
.
I got a "Update the license in your package.json. It did not match what we found on GitHub, and we were unable to resolve this." error for shutterstock/a-swig-service#2.
These can probably go in a .github folder. https://developer.github.com/v3/repos/community/
Dearest humans,
I've run into a problem here. I am trying to update the community docs and to get this repo up-to-scratch. I would usually create a new pull request to let you know about it, or update an existing one. But now there more than one: #30, #22
I don’t know how that happened, did I short-circuit again?
You could really help me by closing all pull requests or leave the one open you want me to keep updating.
Hope you can fix it (and my circuits) soon 🙏
The notes we currently have are not ideal. See shutterstock/juxtaposer#19:
Dearest humans,
You are missing some important community files. I am adding them here for you!
Here are some things you should do manually before merging this Pull Request:
package.json
.keywords
field for now.package.json
is OK. Another one besides your GitHub repo might work. We've set it to https://github.com/shutterstock/juxtaposer.package.json
.Note: This pull request was automatically generated by https://github.com/mntnr/build-a-space. Found an issue? Let me know!
"Update the guide" requires a check, but not necessarily any manual work. The same could be said of the CoC. However, "Add some keywords" requires manual work. Why don't you split these two types of notes up to make it easier to see what to do and what not to do.
For some reason, it wasn't added in this PR. https://github.com/shutterstock/node-favicon-video/pull/1/files This happens every now and then.
This has happened for both the Code of Conduct and the Contributing.md files.
On https://github.com/orbitdb/orbit-bot, the description was in the README, but not in the repo. This is a strange edge case, but should be manageable.
Dearest humans,
I've run into a problem here. I am trying to update the community docs and to get this repo up-to-scratch. I would usually create a new pull request to let you know about it, or update an existing one. But now there more than one: #23, #22
I don’t know how that happened, did I short-circuit again?
You could really help me by closing all pull requests or leave the one open you want me to keep updating.
Hope you can fix it (and my circuits) soon 🙏
Self.
Alternatively, suggest one by adding a URL the user can click to automatically make an issue.
Make this an external manifest.
And possibly a CONTRIBUTORS file, too.
They shouldn't be able to merge until they've manually checked stuff.
You're going to need some eventually. I know, I know, this is early. But I don't want to lose this link: https://github.com/frappe/charts
Might be useful for checking package.json's. https://www.npmjs.com/package/package-json-validator
🚨 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 we are using your CI build statuses to figure out when to notify you about breaking changes.
Since we did not receive a CI status on the greenkeeper/initial
branch, we assume that you still need to configure it.
If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/
.
We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.
Once you have installed CI on this repository, 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 integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.
To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:
.travis.yml
If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.
Greenkeeper has checked the engines
key in any package.json
file, the .nvmrc
file, and the .travis.yml
file, if present.
engines
was only updated if it defined a single version, not a range..nvmrc
was updated to Node.js 10.travis.yml
was only changed if there was a root-level node_js
that didn’t already include Node.js 10, such as node
or lts/*
. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.For many simpler .travis.yml
configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖
There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.
Your Greenkeeper Bot 🌴
We don't always need to edit this.
Some workflows will require this.
🚨 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 integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.
Shouldn't use [email protected]
Might be better for keeping them updated. For instance, one can automatically get CovGen from GitHub:
// const covgen = await github.get(`/codes_of_conduct/contributor_covenant`)
// console.robolog(covgen)
This will involve a couple of things. First, parsing the README. Second, finding the Description or Background section. Then, either topic extraction or NER of that information, with the goal of seeing if you can automatically suggest topics for the README.
For now, noun phrases may do the trick, in the description, for suggestions. This would be greatly aided by a test database of repositories and topics, however.
I'm not sure how to do this in JavaScript. I want these two different solutions to work:
$ ls
contributing.md
config.json # Refers to contributing.md as `contributing.md`
$ build-a-space -c config.json
# Uses contributing.md
$ ls
config.json # Refers to contributing.md elsewhere using global path
$ build-a-space -c config.json
# Knows contributing is global, but is still able to refer to it.
Right now, I can only put config.json in the build-a-space dir, and contributing.md's path has to be relative to basedir. This is not ideal.
This should ideally be a https://probot.github.io, or work with a Probot.
For instance, for what emails to use, or whether to add in Code of Conduct files.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.