pkode v1.5.1
pkode
Table of Contents
About pkode
The problem
I open-source projects and want to make it easier to scaffold and maintain them.
This solution
This package is a CLI that abstracts away all configuration for my open source projects for linting, testing, building, and more.
Inspiration
This tool is inspired by react-scripts
and kcd-scripts
.
Why pkode
name?
pkode
is a short form of my pen name,
Pejuang Kode.
Installation
This module is distributed via npm which is bundled with node and
should be installed as one of your project's devDependencies
:
npm install --save-dev pkode
Usage
This is a CLI and exposes a bin called pkode
. I don't plan on documenting or
testing it super-duper well because it's really specific to my needs. You'll
find all available scripts in src/scripts
.
This project tries to dogfoods itself. If you look in the package.json
, you'll
find scripts with node src {scriptName}
. This serves as an example of some of
the things you can do with pkode
.
More References
Not all of my implementation standards can be automated through scripts due to certain reasons, such as the deprecation of conventional JS config in husky.
Therefore, complement this repository with some guidelines and how-tos that all contributors to my open-source projects can follow.
Guidelines
Values
As guidance in making decisions, we hold on to some values here that we adopted from WargaBantuWarga principles.
How to set up a new project
When setting up a new project, please follow these guidelines to ensure that it complies with our standards of quality.
Contributing
See our contribution guidelines in these languages:
To facilitate healthy and constructive community behavior, we adopt and enforce Contributor Covenant Code of Conduct
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago