How to Contribute

What is GitHub?

GitHub is a website where people collaborate on projects. Think of it like Google Docs for code and content: multiple people can suggest changes, discuss improvements, and track what has been updated over time.

You don't need to know how to code to contribute. Suggestions, feedback, and problem reports can all be submitted through GitHub's website using just your browser.

If you already have a GitHub account, skip to the next section.

1. Go to github.com

   Open your browser and visit github.com.

2. Click "Sign up"

   You'll find this button in the top-right corner of the page.

3. Enter your details

   Provide an email address, create a password, and choose a username. Your username will be visible to others, so pick something professional if you plan to use it for work.

4. Verify your account

   GitHub will ask you to solve a simple puzzle and verify your email address. Check your inbox for a verification email and click the link.

5. You're in

   That's it — you now have a GitHub account and can start contributing.

Ways you can contribute

You don't need to write code to make a meaningful contribution. You can help improve the metrics directory, playbooks, assessment questions, or any other part of the framework. Here are the ways to do it:

Submit an idea or suggestion

This is the easiest way to contribute, no technical skills needed. Ready to jump in? Open an issue on the Distilled CS GitHub repository and skip the walkthrough. Or follow the steps below if you're new to GitHub.

1. Go to the Distilled CS repository

   Visit the project page: github.com/saneeshnp/distilled-cs

2. Click the "Issues" tab

   You'll find this near the top of the repository page. It's the third tab, between "Code" and "Pull requests".

3. Click "New issue"

   This is a green button on the right side of the Issues page.

4. Choose a template

   You'll see options for common types of contributions — like "Suggestion / Improvement" or "New Content Proposal". Pick the one that fits best.

5. Write a clear title

   Summarize your idea in one line. For example: "Add Customer Effort Score (CES) to the metrics directory" or "Crawl stage description should mention SMB challenges".

6. Describe your suggestion

   In the description box, explain:

   • What you're suggesting and why
   • Any context from your own CS experience
   • Links or references if applicable
7. Click "Submit new issue"

   Your suggestion is now visible to the community. We'll respond, ask follow-up questions, or tag it for inclusion.

Report a problem

Found something broken on the website? Follow the same steps as above, but include these details:

• What happened — Describe what you saw (e.g., "The checklist page shows an empty list after completing the assessment").
• What you expected — Describe what should have happened instead.
• How to reproduce it — List the steps someone else can follow to see the same problem (e.g., "1. Complete the assessment. 2. Go to /checklist/. 3. Notice the list is empty.").
• Your browser and device — For example, "Chrome 120 on Windows 11" or "Safari on iPhone 15".
• Screenshots — If possible, include a screenshot. You can paste images directly into the GitHub issue form.

Contribution guidelines

To keep contributions consistent and high-quality, please follow these guidelines:

• Be vendor-neutral — Don't reference specific tools or vendors in framework content. Distilled CS is tool-agnostic.
• Cite your sources — If you're proposing benchmarks or data, share where the numbers come from.
• Keep it practical — Recommendations should be actionable by real CS teams, not theoretical ideals.
• Be respectful — Engage constructively in discussions. Disagree with ideas, not people.
• One change at a time — Keep each suggestion or edit focused on a single topic. It's easier to review and accept a change that does one thing well.

Need help?

Stuck on any step? There are two easy ways to reach us:

• Open a GitHub issue — ask a question, share a thought, or flag something you're unsure about. There's no wrong way to use it.
• Send us a message on LinkedIn — prefer a conversation over a form? Reach out to Distilled CS on LinkedIn and we'll get back to you.

Every contribution, no matter how small, helps make Customer Success better for everyone. Thank you for being part of this.

See the current contributors →