README.md

conventional-changelog

Table of Contents generated with DocToc

• conventional-changelog
  • Joining the conventional-changelog Organization
    • Setup Two-factor Authentication
  • Setting Up a Project
    • GitHub Labels
  • Common Issues
    • Disabling Two Factor Authentication

Joining the conventional-changelog Organization

There are a few tasks that will need to be completed prior to joining the conventional-changelog organization as an administrator, project owner, or outside collaborator.

Some tasks are requirements while others will simply make your experience, and that of others, better.

Setup Two-factor Authentication

Required

All accounts with access to the conventional-changelog organization must have 2FA authentication enabled with GitHUb.

This is part of our continued efforts to improve the security of this organization (to minimize, or prevent, incidents such as this)

Setting Up a Project

Once you have a new project on conventional-changelog's organization, it's time to get your project setup with a few things to make your life easier.

GitHub Labels

To help with issue and pull request management, we recommend a set of GitHub Labels in this project's configuration.json file.

To deploy these labels to a project, please install @hutson/github-metadata-sync, download the configuration.json file (or clone this repository), and run the following:

github-metadata-sync --token [PERSONAL ACCESS TOKEN] --config configuration.json

Note: Please create a Personal Access Token with repository access to all repositories listed in the configuration.json file and pass that token to the --token flag.

Common Issues

Disabling Two Factor Authentication

According to GitHub:

Warning: If you're a member, billing manager, or outside collaborator to a public repository of an organization that requires two-factor authentication and you disable 2FA, you'll be automatically removed from the organization, and you'll lose your access to their repositories. To regain access to the organization, re-enable two-factor authentication and contact an organization owner.

In the event that you disable, and then re-enable, 2FA, please reach out to a member of the organization to be re-invited.