Wondering what’s next for npm?Check out our public roadmap! »

    maintain-me

    0.4.0 • Public • Published

    maintain-me

    GitHub Issues GitHub Pull Requests MIT License Donate via PayPal Become a Patron!

    Currently a WORK IN PROGRESS.

    The current functionality of this module replaces existing files with pre-defined templates.

    Fulfill all of GitHub's community standards with one command.

    maintain-me

    You can find the Community profile for your GitHub repo at github.com/username/repo/community.

    You must be logged into GitHub to view this page for whichever repo.

    Community Standards

    Installation

    npm i -g maintain-me

    Usage

    maintain-me

    This creates the following files:

    .
    ├── .github
    |  ├── CODE_OF_CONDUCT.md
    |  ├── CONTRIBUTING.md
    |  ├── ISSUE_TEMPLATE
    |  |  ├── Bug_report.md
    |  |  └── Feature_request.md
    |  ├── ISSUE_TEMPLATE.md
    |  └── PULL_REQUEST_TEMPLATE.md
    ├── LICENSE
    └── README.md

    Use npm i -g tree-cli and tree -l 4 -a --ignore 'node_modules, .git, fixtures' to create the graph above.

    Testing

    npm run test

    Running Module Locally

    Symlinking a package folder is an easy way to test a node module locally.

    # change into maintain-me directory 
    cd maintain-me
    # create a global symlink to the local "maintain-me" project 
    npm link
    # change directory to github-repo that has a package.json 
    cd github-repo
    # create a symlink locally to global maintain-me symlink 
    npm link maintain-me

    Deployment

    np

    Contributing

    To get started...

    1. 🍴 Fork this repo
    2. 🔨 View the contributing guidelines at CONTRIBUTING.md
    3. 👥 Add yourself as a contributor under the credits section
    4. 🔧 Open a new pull request
    5. 🎉 Get your pull request approved - success!

    Or just create an issue - any little bit of help counts! 😊

    Code of Conduct

    In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

    More details can be found at this project's code of conduct.

    Further Resources

    Credits

    Install

    npm i maintain-me

    DownloadsWeekly Downloads

    1

    Version

    0.4.0

    License

    MIT

    Unpacked Size

    18.4 kB

    Total Files

    12

    Last publish

    Collaborators

    • avatar