Giter Club home page Giter Club logo

carbonated's Introduction

carbonated

Carbonated is released under the Apache-2.0 license CircleCI lerna PRs welcome!

Internal services for building the Carbon Design System.

Getting started

This project is built using a collection of packages all built in the same git repository. You might have heard this setup described as a monorepo.

As a result, we use two pieces of tooling to help us managing installing dependencies and publishing our packages. These include:

  • Yarn workspaces for handling dependencies across all packages
  • Lerna for publishing packages, tagging versions, and more

In order for you to install all the dependencies in this project, you'll need to install Yarn and run the following command in your terminal while using Node v10:

yarn install --frozen-lockfile

Note: the current Node.js version of the project is specied in the engines field of package.json

This will install all of the dependencies for every package in our project. In addition, it allows us to link between packages that we are developing.

Next up, you'll most likely want to build all of the package files so that things don't fail while you are working on a package. To do this, you can run the following command:

yarn build

Afterwards, you should be good to go! Look at each individual package or service's README.md file for more instructions.

๐Ÿ™Œ Contributing

We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide ! ๐Ÿ‘€

๐Ÿ“ License

Licensed under the Apache 2.0 License.

carbonated's People

Contributors

dakahn avatar joshblack avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

carbonated's Issues

test

seeing if stale works

Carbonated Wishlist

Carbonated is an internal tooling project for the Carbon Design System. It will eventually be composed of the following service areas:

  • Adoption: track adoption-related KPIs and provide insights into performance
  • Audits: research usability of components in the system
  • Automation: typically done through GitHub bots. Provides attempts at automation where appropriate in our process
  • Management: ability to manage team and repo settings across the ecosystem
  • Support: help carbon developers better service users on GitHub and Slack

  • Support
    • Review queue for PRs, similar to: https://buildbot2.rust-lang.org/homu/queue/rust
    • Issue triage view
      • View issues that have not been responded to yet
      • View issues that have not been triaged yet
    • PR triage view
      • View PRs for me to review
    • View stale issues/PRs
  • Management
    • Team
      • Manage roster of employees through GitHub
        • Automatically add to appropriate teams and repos
    • Repositories
      • Add ability to sync GitHub settings between repos we manage
        • Issue labels
        • Milestones
        • Branch permissions
    • CircleCI
      • Add ability to sync CircleCI settings and tokens between repos we manage
  • Automation
    • Bots
      • GitHub
        • Automatically respond to first-time contributors with link to CLA
        • Close stale issues and pull requests
        • Automatically merge in approved PRs
        • Automatically label PRs based on status checks
      • Slack
        • Automatically make issue from channel
        • Use key words to properly direct folks towards the right channel
  • Audits
    • Usability
    • Accessibility

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.