Skip to main content

Contributing to Enable Learn

Thank you for your interest in contributing to Enable Learn! This platform is designed to help everyone create better documentation and learning resources.

Code of Conduct​

We are committed to fostering an open and welcoming environment. By participating, you agree to uphold our Code of Conduct, which ensures a positive experience for everyone involved in the project.

Ways to Contribute​

There are many ways you can contribute to Enable Learn:

  • Documentation Improvements: Fix typos, clarify explanations, or update outdated content
  • New Tutorials: Create new tutorials covering documentation best practices
  • Feature Requests: Suggest new features or improvements for the platform
  • Bug Reports: Help us identify and fix issues

Submission Process​

🐛 Issues and Bug Reports​

If you find a bug or issue with the platform:

  1. Check existing issues to avoid duplicates
  2. Use our issue template to provide detailed information
  3. Include steps to reproduce the problem
  4. Add screenshots if applicable

💡 Feature Requests​

Have an idea for improving Enable Learn?

  1. Search existing feature requests first
  2. Open a new issue describing your idea
  3. Explain the benefits and use cases
  4. Be open to discussion about implementation details

🔄 Pull Requests​

If you'd like to contribute code or content:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Commit with clear messages (git commit -m 'Add amazing feature')
  5. Push to your branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

Content Guidelines​

🏗️ Structure​

All content should follow a clear structure:

  • Introduction: What will users learn?
  • Prerequisites: What do they need to know first?
  • Main Content: Step-by-step instructions with explanations
  • Conclusion: Summary of what was learned
  • Next Steps: Where to go from here

✍️ Style​

  • Use clear, concise language
  • Break complex topics into manageable sections
  • Include examples wherever possible
  • Use visuals to enhance understanding

📝 Formatting​

  • Use Markdown for all content
  • Organize with proper headings (H1 for title, H2 for main sections, etc.)
  • Use code blocks with language specification for code examples
  • Include alt text for all images

Testing Your Changes​

Before submitting your contribution, please test your changes locally:

npm install
npm start

This will start a local development server where you can preview your changes.

☁️ Using GitHub Codespaces​

If you prefer not to set up a local environment, you can use GitHub Codespaces:

  1. Fork this repository
  2. Click the "Code" button and select "Open with Codespaces"
  3. Wait for the container to build and connect
  4. Open a terminal and run npm start

Document Structure​

The repository is organized as follows:

  • docs/: Contains all tutorial and guide markdown files
  • static/img/: Houses all images used in documentation
  • src/: Source code for the website framework

Getting Help​

If you have questions about contributing, please:

  • Open an issue labeled "question"
  • Check the existing documentation
  • Join our community discussions

Thank you for helping make Enable Learn better for everyone!