Giter VIP home page Giter VIP logo

pristine-typescript's Introduction

Pristine Typescript

A typescript open source repository in its original condition.

Pristine Typescript a fork of Pristine.

There are a lack of repositories to start from to build community driven open source projects. Pristine Typescript is a complete starting point, it follows a Documentation Driven Development approach, and can be used as a resource to augment existing documentation.

How to use Pristine in your project

There are 2 options for using pristine with your project.

  1. Fork this repo as the start of your own, OR
  2. follow these instructions to use it on an existing repository.

Documentation Driven Development

There are many ways to drive open source development. Documenting the problem in the README gives a middle ground between technical and non-technical specifications. This allows organizing solutions to this challenge around community and documentation.

[...] a beautifully crafted library with no documentation is also damn near worthless. If your software solves the wrong problem or nobody can figure out how to use it, there’s something very bad going on.

Conventions and Specifications

This repository has some strong opinions built in like circleci, semantic-release, npm. So feel free to fork and change it at your own discretion. It is only meant to be a starting point. That being said:

Using conventions, documentation and specifications make it easier to:

  • communicate the problem you are solving
  • ease onboarding
  • build and use composable tools
  • promote open source contribution and engagement
  • promote issue and feature discussion on Github itself

Resources

Getting Started

To get started, fork or duplicate the repository. Then edit this file and delete everything above this line.

Contributing

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.

pristine-typescript's People

Contributors

belfordz avatar dependabot-preview[bot] avatar dependabot[bot] avatar devonwesley avatar meowsbits avatar shanejonas avatar stevanlohja avatar zcstarr avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

zcstarr

pristine-typescript's Issues

semantic-release should not commit to master

Is your feature request related to a problem? Please describe.
At the moment, when semantic release is doing the publish step, it includes the changelog.

However, it also commits the changelog, and pushes this commit to master. Since master should be a protected branch, this presents some challenges that force us to loosen the rules, and to put powerful tokens in sketchy places.

Describe the solution you'd like
semantic-release should do everything on a release branch, opening a PR with the results instead of pushing them directly to master. This PR should be ignored by CI.

Describe alternatives you've considered
I've tried nothing and I'm all out of ideas.

Additional context
Perfection is the goal here ladies & non ladies.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.