Contributing to IT-Journey

Thank you for your interest in contributing to IT-Journey! We welcome contributions from developers, content creators, and learners of all experience levels.

Quick Start

1. Read the Developer Guide: See the comprehensive Developer Contributing Guide
2. Setup Your Environment: Follow the Development Environment Setup
3. Understand the Structure: Review Repository Structure
4. Follow Standards: Check Content Guidelines and Frontmatter Standards

Documentation

All technical documentation for contributors has been moved to the docs/ directory:

Essential Reading

• Developer Contributing Guide - Complete contribution workflow
• Repository Structure - Directory organization
• Development Environment - Setup instructions
• Content Guidelines - Writing standards
• Frontmatter Standards - Metadata requirements

Additional Documentation

• Jekyll Implementation - Jekyll details
• GitHub Actions - CI/CD workflows
• Scripts Guide - Automation tools
• Testing Frameworks - Quality assurance

Types of Contributions

Content Creation

• Write blog posts and tutorials
• Create gamified quests
• Add educational documentation
• Contribute Jupyter notebooks

Code Contributions

• Improve automation scripts
• Enhance testing frameworks
• Optimize workflows
• Fix bugs and issues

Documentation

• Improve developer documentation
• Add learning resources
• Update guides and tutorials
• Fix typos and errors

Community Support

• Help answer questions
• Review pull requests
• Share your experiences
• Mentor new contributors

Prerequisites

Before contributing, you should have:

• Git and GitHub account
• Development environment set up (see setup guide)
• Familiarity with Jekyll (see Jekyll docs)
• Understanding of repository structure (see architecture docs)
• Knowledge of contribution standards (see contributing guide)

Quick Contribution Workflow

# 1. Fork and clone
git clone https://github.com/YOUR-USERNAME/it-journey.git
cd it-journey

# 2. Create branch
git checkout -b feature/your-feature-name

# 3. Make changes
# Edit files, test locally

# 4. Commit with conventional format
git commit -m "feat(scope): description"

# 5. Push and create PR
git push origin feature/your-feature-name
# Create Pull Request on GitHub

See the Developer Contributing Guide for detailed workflow instructions.

Code of Conduct

• Be respectful and inclusive
• Welcome newcomers and beginners
• Provide constructive feedback
• Focus on the work, not the person
• Respect different perspectives
• Be patient and empathetic

Getting Help

Questions

• Check documentation first
• Search existing issues
• Create discussion in GitHub Discussions
• Ask in pull request comments

Issues

• Bug reports: Use bug label
• Feature requests: Use enhancement label
• Questions: Use question label
• Documentation: Use documentation label

Support Channels

• Technical Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation: See docs/ directory in repository
• Email: For sensitive issues only

Recognition

Contributors are recognized through:

• Repository contributors page
• Release notes acknowledgments
• About page (for significant contributions)
• Special recognition in related content

License

By contributing, you agree that your contributions will be licensed under the MIT License.

For complete contribution guidelines, please see the Developer Contributing Guide.

Last Updated: 2025-10-13