/Patternugit

Preconfigured pattern for your repository with universal cases for markdown files of documentations and other actions/scripts

Primary LanguageJavaScriptMIT LicenseMIT

contributors stargazers forks issues commit-activity

icon

Patternugit

Everything could be systemized, you just need to try.
Contribute to us / View tags / Report a bug

About the project

Don't want to set up repository, work with those boring documentations, scripts and want to work as fast as possible on your project, but also have a wish1 for your project to be great in extensibility and automation?

Project of this is the exact problem solution for you, the big and advanced repository with some documentations, scripts, settings, configs, simple things with simple solutions.

Built-with

Project is created and “written” with help of:

JAVASCRIPT
TYPESCRIPT
PYTHON

Getting started

Before asking questions, read this block because here is all the primary information on the project, which can answer your future not-yet asked questions.

Prerequisites

For usage of this project just as template for your repository, there is no direct prerequisites besides Node.js.

But, for contributing to this project, we highly recommending following those prerequisites:

  • Installed Node.js on your desktop on which you will edit/setup this project;
  • Installed Python if you want to contribute to the scripts of this project (in terms of .PY scripts);

[^]

Installation

Permission is granted for free use in any of your products.

If you want to use this project, there are two ways to download-and-use this project: “official” and direct, so, let's start from official path:

  1. Go up to the “main position” of page of this repository and seek for the "Use this template" button;
  2. Click on this button and seek for the specified variants "Use this template → Create a new repository", or option with codespaces;
  3. Use project, edit anything you want.

Guidelines for direct-installation way:

  1. Download last tag on project's repository, for the last ZIP-tarball link provided below:
    download latest release
    • or just download the source-code through "Code → Download ZIP (or any option that you want)", and proceed to the next step;
  2. Within downloaded ZIP (or project), clone everything and paste to the directory of your project via "copy+paste" procedure;
  3. Now, you can use project just as if you installed it from other algorithms.

Guidelines for installation of source code of this project:

  1. Clone the repository with any form of app which supports git (or CLI of this site), guide is attached:
    https://www.howtogeek.com/451360/how-to-clone-a-github-repository/
  2. Open it with any suitable for you editor and feel free to customize, update and/or contribute to this project2.

[^]

Usage

Usage of this project is very easy and comfortable for common user, its not provided with any advanced code or anything, it just the "data" which user must interpretate as it wants.

  1. Go to your project's directory and paste the contents of this template, which were installed with help of installation guides3;
  2. Now, you can continue to work on your project with this template's data in it.

Before preparing to work on the projects that you prepared, initialize entire repository via initialize and prepare commandlets of NPM (through either bash or powershell):


# Installing every dependency for package:
npm i
# Using prepare script for this repository:
npm run prepare

[^]

Roadmap

  • Create basic repository infrastructure for this project, including:
    • basic .MD documentations and dealings stuff (like README, LICENSE and etc.);
    • scripts and actions within CI/CD for supporting high-quality of this project;
  • Write and publish the demo (pre-release) version of project, including the most basic logic of this one.
  • Write the documentation for this demo-project and:
    • make it one as archive for technical docs purposes (hyperlinking directive);
  • Refactor and prepare for “advancing” the project's logic and write an entire functionality of it.
    • Write an advanced .TS script for managing core of this project's functionality (being a template);
    • Write an advanced infrastructure for project's surroundings and etc.;
  • Refactor and prepare for “advancing” the project's documentation and publish it via the archive.

[^]

Contributing

Contributions are what make open source community such an interest place to be in, so any form of contribution are greatly appreciated.

If you think that you can help this project become better but think its not so important/realizable in the current situtation or for a full contribution, use issues page, otherwise there is a guideline and policy for contributing.

If you want to contribute to this project, please, read contributioning policy and commit convention, this repository works with CLA, commits convention and on automated deployment system4.

For one-single file contributioning, use a more quicker way without forking the repository through website.

More about it in this article:

[^]

License

Project thanks the Electron.js and Angular.js for their amazing repository scripts and entire infrastructure, which partially were imported to this repository.

Project itself is being distributed under the MIT License — see the file for more specified information.

[^]

Contact

For any legal purposes, you can contact developer/maintainer through its e-mail:

If the developer/maintainer didn't answered, or you have other questions in nature, you can use issues page on this repository via specified templates or indirect self-written issue.

[^]

Acknowledgments

[^]

Footnotes

  1. For this, please, read README and keep in mind, that this is a template and if you want to, you could redefine entire structure of this file or entire repository. ↩

  2. for contributing policy, see — CONTRIBUTING.md ↩

  3. .../#installation ↩

  4. read the files of commiting convention policy and contributioning policy ↩