mntnr / audit-templates

🏔 Auditing templates used by Maintainer Mountaineer!

Welcome

Documentation, notes, drafts, and information

Welcome the Maintainer Mountaineer's organization on GitHub!

You'll find most of the information you need on our website. If you have public questions, open an issue here, and we'll do our best to respond as soon as possible.

If you have private questions, email [email protected].

Join our Slack Group!

Resources

Here are some awesome, related resources you can check out.

Developed here:

• Name Your Contributors - Name your GitHub contributors; get commits, issues, and comments.
• Standard Readme - One README to rule them all.

Developed elsewhere:

• Alex Catch insensitive, inconsiderate writing. Website
• Code Triage Set up code triaging help for volunteers. Assumes you have volunteers.

Common Questions

Why is everything licensed by Burnt Fen Creative LLC?

That is @RichardLitt's shell company he uses for consulting services. Maintainer Mountaineer aims to some day be its own business, but for now, for licensing and invoicing purposes, Burnt Fen Creative is used.

Why are there so many forks?

Maintainer.io policy is to fork repositories when we do public code and repository audits. If we have a fork here, that means we were contacted about auditing a repository. For Maintainer source repositories, you can see this filter on the @mntnr page.

Can I haz stickers?

Yes! Send us an email or open an issue with your name and address, and we'll send a few out to you.

Code of Conduct

Everything @mntnr related follows the Contributor Covenant. Please be nice.

License

CC-BY-SA-NC 4.0 Unlicensed (c) Burnt Fen Creative LLC 2017.

audit-templates's Issues

Consider rewording language around CLAs

Love this template! My one piece of feedback is that the wording around CLAs seems to strongly support them and stress their need legally; however, I have recently heard many good arguments against them. Here's a longer form more explanative version of why: https://ben.balter.com/2018/01/02/why-you-probably-shouldnt-add-a-cla-to-your-open-source-project/.

Confusing (possibly outdated?) instructions to audit client

I'm not sure what "For notes on anything crossed out, look below." means. I don't recall seeing crossed out items in the audits I've looked at. Is crossing stuff out part of the current workflow? Also, "below" is non-specific - where below? (TODO section? Somewhere else?)

Create tool to (better) automate file/folder checks

My quick and dirty way has been with commands like:

ls -lR |grep -i -e ISSUE_TEMPLATE.md -e PULL_REQUEST_TEMPLATE.md -e CONTRIBUTING.md

That can of course be improved by putting the list of things to search for in a source file for grep (or find), or better, by creating a shell script that does this.

Even better would be to modify the shell script that creates the audit "shell" by initializing a custom audit file in which the shell script is run and then modifies the audit file with the results of the file/folder checks.

No explanation for what DESCRIPTION should contain

Per audits Richard has done, it seems this should be the description of the repo being audited. Also, Richard seems to excise the link in the source repo's description when he does this. Is that intentional?

Minor error in notes between DESCRIPTION and checklist

"Note: I use [ ] to mean..." should be "Note: I use [~] to mean..."; somehow I think the tilde got dropped.

Action required: Greenkeeper could not be activated 🚨

🚨 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.

Code of Conduct example link is broken

For this item:

Is there a Code of Conduct, such as the Contributor Covenant?

the link to the Contributor Covenant 404s. The correct link is currently: https://github.com/simonv3/covenant-generator