Skip to content
This repository has been archived by the owner on Mar 21, 2023. It is now read-only.

Latest commit

 

History

History
45 lines (36 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 2.62 KB
Raw

Contributing to Specter

Welcome

We are glad you are here! We think it's awesome that you want to spend time helping us make Specter even better. We really value the community we get to be a part of, and we are grateful for your contribution.

Contribution requires signing a Contributor License Agreement (CLA) via HelloSign, a process automated as a part of a pull request. Your Github email address must match the email address used to sign the CLA. Github has documentation on setting email addresses. Your git email must also match this email address.

How to Contribute to Specter

The basic workflow:

  1. You have an idea or see something that you want to fix, so ...
  2. Fork Specter
  3. Start a new branch for your feature
    • Branch prefixes we use:
      • feature/: for features
      • support/: for general refactoring
      • hotfix/: something broke and we need to fix it now
  4. Submit a Pull Request! Do it early and mark it WIP so a maintainer knows it's not ready for review just yet.
  5. If you haven't signed our CLA before, then you will receive an email from HelloSign to sign the CLA.
    • The CLA request will be sent to the email address associated with your github account.
    • You cannot have your PR merged without signing the PR.
    • If you already submitted a PR and need to correct your user.name and/or user.email please do so and then use git commit --amend --reset-author and then git push --force to correct the PR.
  6. Request review from one of our maintainers.
  7. Get Approval. We'll let you know if there are any changes that are needed.
  8. Boom! You can merge your changes into Specter.

Pull Requests:

  • Submit a PR to get your changes approved
  • Request review from a maintainer
  • Make sure you include an explanation of what's changed, why, and anything these changes affect
  • The CLA-bot will confirm that you're approved to contribute
  • Our maintainer will review and approve your PR
  • Merge!

Community Guidelines

  1. Be Kind - Working with us should be a fun learning opportunity, and we want it to be a good experience for everyone. Please treat each other with respect.
    - If something looks outdated or incorrect, please let us know! We want to make Specter as useful as possible.
  2. Own Your Work
    • Creating a PR for Specter is your first step to becoming a contributor, so make sure that you own your changes.
    • Our maintainers will do their best to respond to you in a timely manner, but we ask the same from you as the contributor.

Thank you!