ConsoleMe
GitHub
  • About
  • Architecture
  • Features
    • Credentials
      • AWS Console Login
      • AWS Credential Broker
    • Policy Management
      • Policies View
      • Policy Editor for IAM, SQS, SNS, and S3
      • Self-Service IAM Wizard
      • Policy Request - Review Page
      • Role Creation and Cloning
  • Demo
  • Quick Start
    • Docker
    • Local
  • Prerequisites
    • Required IAM Permissions
      • Central Account
      • Spoke Accounts
  • Configuration
    • Web App Authentication and Authorization
      • Local Development (Auth bypass)
      • ALB Auth (Recommended)
      • Retrieving Google Groups
      • OIDC/OAuth2
        • Cognito
        • Okta
      • SAML
      • Plain-Text Headers
    • Role Credential Authorization
      • Role Tags
        • Role Tagging Service Control Policy (Recommended)
      • Role Authorization through Dynamic Configuration
      • Custom Authorization (Internal Plugin)
    • Account Syncing
    • Metrics
    • Dynamic Configuration
    • AWS Resource Syncing
    • CLI Authentication
    • Sending email through SES
    • AWS Secret Manager Integration
    • CloudTrail Integration via AWS Event Bridge
    • Slack Notifications
  • Celery Tasks
    • Celery Flower
  • Development Guide
    • UI Components
    • Managing Dependencies
  • Deployment Strategies
  • Contributing
  • FAQ
  • License
  • Security
  • Weep CLI
    • Getting Started with Weep
    • AWS Credentials in the CLI using Weep and ConsoleMe
    • Configuration
    • Commands
      • List
      • Serve
      • Export
      • File
      • Credential Process
    • Assuming Roles
    • Advanced Configuration
      • Routing for Metadata Service
      • Shell Completion
Powered by GitBook
On this page
  • How to get started
  • Join the conversation
  • Reporting issues
  • Submitting code and documentation changes
  • Pre-commit setup
  • Keeping your fork up to date

Was this helpful?

Contributing

PreviousDeployment StrategiesNextFAQ

Last updated 3 years ago

Was this helpful?

How to get started

There are ways for anyone to contribute to ConsoleMe and Weep, regardless of technical expertise. Take a look at the and .

Documentation improvements are one of the easiest ways to help out. We can always make our documentation more thorough, intuitive, and accessible, and the best way to do that is for people like you to read through the docs (and try things out, if you want). You don't even need to know how to use Git to help with this -- it's as easy as .

Join the conversation

The project maintainers use Discord for synchronous conversation about ConsoleMe and Weep development. If you don't know where to start, and say hello.

Reporting issues

We use GitHub issues to keep track of what needs to be done. Issues can be opened for bugs, feature requests, missing documentation, etc.

to create an issue for ConsoleMe. to create an issue for Weep.

Submitting code and documentation changes

Before making code changes, of the .

# Clone your fork, substituting your_username for your GitHub username then go into the repo root
git clone git@github.com:your_username/consoleme.git
cd consoleme

# Create a new branch for your changes
git switch -c my-branch

Now you can make your changes and save them. Once you've made changes, added/updated tests, and are ready to upload:

# Replace file1 with a list of the files you'd like to commit
git add file1
git commit -m "A short description of your change"
git push -u origin my-branch

Pre-commit setup

pip install pre-commit

# Validate your install
pre-commit --version

# Make pre-commit run when you commit (run this once per repo)
pre-commit install
brew install pre-commit

# Validate your install
pre-commit --version

# Make pre-commit run when you commit (run this once per repo)
pre-commit install
conda install -c conda-forge pre-commit

# Validate your install
pre-commit --version

# Make pre-commit run when you commit (run this once per repo)
pre-commit install

Keeping your fork up to date

Since your fork is a copy of the repository, you have to keep it in sync with our copy. You can do that by adding our copy as a remote, then pulling the changes from the master branch:

# From the consoleme repository root, check out your master branch
git switch master
# Add a remote called upstream
git remote add upstream git@github.com:Netflix/consoleme.git
# Pull changes from upstream
git pull upstream master
# Push changes to your fork
git push origin master

ConsoleMe and Weep use for linting and running tests. Pre-commit can be installed and configured a few different ways:

You're not required to run pre-commit locally, but it will make your life much easier since we run it (and enforce its success) in our CI. For more information, check out the .

open issues for ConsoleMe
open issues for Weep
opening an issue
join our server
Click here
Click here
make a fork
ConsoleMe repository
pre-commit
pre-commit documentation