Nimble Pixie Merchant

    generator-projectfiles

    1.0.1 • Public • Published

    OSS Project Files Generator GitHub version

    Build Status Code Climate Dependency Status devDependency Status Coverage Status Total views

    Yeoman generator for standard OSS project files such as README.md, CONTRIBUTING.md, LICENSE, EditorConfig and more!

    Table of contents

    Quick Start

    Install generator-projectfiles with NPM NPM version:

    npm install -g generator-projectfiles

    Make a new directory, and cd into it:

    mkdir my-new-oss-project && cd $_

    Run yo projectfiles, and answer the prompts

    yo projectfiles

    Then run any of the provided generators to create the corresponding file.

    Generators

    Available generators:

    readme generator

    Generates a README.md file, with prompts for customization

    yo projectfiles:readme

    license generator

    Generates a LICENSE file, will prompt for a list of popular OSS Licenses

    yo projectfiles:license

    contributing generator

    Generates a CONTRIBUTING.md file - inspired by @necolas/issue-guidelines

    yo projectfiles:contributing

    editorconfig generator

    Generates an .editorconfig file, with prompts for customization

    yo projectfiles:editorconfig

    Change Log

    refer to the releases section for a detailed ChangeLog

    Documentation

    Refer to the Wiki for detailed API documentation.

    Bugs and feature requests

    Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

    Contributing

    Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

    More over, if your pull request contains JavaScript patches or features, you must include relevant unit tests.

    Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

    Contribute and Earn

    Donate bitcoins to this project or make commits and get tips for it. If your commit is accepted by project maintainer and there are bitcoins on its balance, you will get a tip!

    tip for next commit

    Donating

    Donations are welcome to help support the continuous development of this project.

    GitTip PayPal

    Community

    Keep track of development and updates.

    Versioning

    For transparency into our release cycle and in striving to maintain backward compatibility, this project is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to these rules whenever possible.

    Releases will be numbered with the following format:

    <major>.<minor>.<patch>

    And constructed with the following guidelines:

    • Breaking backward compatibility bumps the major while resetting minor and patch
    • New additions without breaking backward compatibility bumps the minor while resetting the patch
    • Bug fixes and misc changes bumps only the patch

    For more information on SemVer, please visit http://semver.org/.

    Authors

    Ahmad Nassri

    License

    Licensed under the MIT license.

    Install

    npm i generator-projectfiles

    DownloadsWeekly Downloads

    0

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • ahmadnassri