Contributing to Career Topologies

How to contribute to the Career Topologies open-source project

Career Topologies is an open-source project, and we welcome contributions from the community.

Whether you're implementing the framework in your organization, researching career development practices, or building tools for the community, your contributions help make Career Topologies better for everyone.

Ways to Contribute

Feedback & Discussion

Share your experience implementing the framework, suggest improvements, or ask questions

  • Report challenges encountered during implementation
  • Suggest new features or improvements
  • Ask clarifying questions about the framework

Documentation

Improve clarity, fix errors, add examples, or expand explanations

  • Fix typos or grammatical errors
  • Add concrete examples to abstract concepts
  • Improve clarity of existing documentation

Case Studies

Contribute real-world implementation stories and lessons learned

  • Document your organization's framework customization
  • Share metrics and outcomes from implementation
  • Describe challenges and how you overcame them

Code & Tools

Enhance the website, build tools, or create visualizations

  • Improve website UI/UX
  • Add interactive components or diagrams
  • Build implementation calculators or assessment tools

Research

Add academic references, evidence, or new research findings

  • Cite relevant academic research
  • Add case studies from technology companies
  • Document evidence for specific design decisions

GitHub Workflow

We follow a standard fork-and-pull-request workflow. Here's how to contribute code or documentation:

1. Fork the Repository

Visit the Career Topologies GitHub repository and click the "Fork" button to create your own copy.

2. Clone and Create a Branch

terminal
1# Clone your fork
2git clone https://github.com/YOUR_USERNAME/careertopologies-docs.git
3cd careertopologies-docs
4
5# Create a feature branch
6git checkout -b feat/your-feature-name
7
8# Install dependencies
9pnpm install

3. Make Your Changes

Edit the relevant files. For documentation changes, look in the apps/web/app/ directory. Ensure your changes follow the existing code style and conventions.

4. Test Your Changes

terminal
1# Run the development server
2pnpm dev
3
4# Open http://localhost:3000 and verify your changes
5
6# Run type checking
7pnpm typecheck
8
9# Run linter
10pnpm lint

5. Commit and Push

terminal
1# Stage your changes
2git add .
3
4# Commit with a descriptive message
5git commit -m "feat: add example to progression pillars page"
6
7# Push to your fork
8git push origin feat/your-feature-name

6. Create a Pull Request

Go to the original repository on GitHub and click "New Pull Request". Select your fork and branch, then provide a clear description of your changes:

  • What problem does this solve?
  • What changes did you make?
  • How can reviewers test it?
  • Any relevant screenshots or examples?

7. Collaborate on Review

Maintainers will review your pull request and may suggest changes. Be responsive to feedback and make requested updates. Once approved, your contribution will be merged!

Code of Conduct

We are committed to providing a welcoming and inclusive environment for all contributors. All participants are expected to:

  • Be respectful and considerate in all interactions
  • Welcome newcomers and help them get started
  • Accept constructive criticism gracefully
  • Focus on what is best for the community
  • Show empathy towards other community members

Unacceptable behavior includes harassment, discrimination, personal attacks, or any conduct that creates an intimidating or hostile environment. Violations will not be tolerated.

View on GitHubBrowse Issues