Skip to content

Contributing to Plateforme

Join our alpha phase development

We're actively seeking contributors to help accelerate our path to beta release. Your expertise in documentation and test development would be particularly valuable during this critical phase. Contact us through Discord to get started.

Code review

Alpha phase notice

During the alpha phase, code review is limited to the core development team. Code review will open to the broader community after our beta release.

The code review process is essential for maintaining high-quality software. Reviewers should focus on:

  • Review process

    •   Review open pull requests
    •   Evaluate code structure and implementation
    •   Suggest performance optimizations
    •   Verify alignment with the style guide
    •   Validate changes against test suite

  • Review standards

    •   Provide specific, actionable feedback
    •   Focus on technical merit and quality
    •   Consider performance implications
    •   Verify test coverage
    •   Review documentation updates

Issue management

Supporting users through our issue tracker provides valuable assistance to the community:

  • Response standards

    •   Request clarification for unclear issues
    •   Provide relevant code examples
    •   Reference official documentation
    •   Help create minimal test cases
    •   Maintain professional communication

  • Issue categories

    •   bug - Bug reports
    •   documentation - Documentation issues
    •   duplicate - Duplicate issues
    •   enhancement - Feature requests
    •   good-first-issue - Beginner-friendly tasks
    •   help-wanted - Assistance requests
    •   invalid - Invalid issues
    •   question - General questions
    •   performance - Performance concerns
    •   wontfix - Closed issues

Pull request requirements

Alpha phase notice

External pull requests are not being accepted during the alpha phase to maintain stability as we establish core functionality. Pull request contributions will be welcomed after our beta release.

For future reference, pull requests should meet the following criteria:

  • Requirements

    •   Address existing issues
    •   Include comprehensive tests
    •   Update relevant documentation
    •   Follow coding standards
    •   Provide clear change descriptions

  • Process

    1. Join Discord
    2. Discuss changes with core team
    3. Obtain approval before development
    4. Submit changes for review
    5. Address feedback promptly

Documentation

Documentation improvements are crucial for Plateforme's development. We focus on several key areas to ensure comprehensive and accurate documentation. Your contributions can include:

  •   Technical accuracy improvements
  •   Example code updates
  •   Content organization
  •   API documentation
  •   Tutorial development
Documentation repository

The documentation uses Material for MkDocs and resides in the docs directory. To contribute:

  1. Fork the repository
  2. Create a feature branch
  3. Make improvements
  4. Test locally - refer to the project README
  5. Submit for review

Community engagement

Your contributions matter to us. All contributors are acknowledged in the official repository.

Check out our code of conduct and community guidelines to learn more about our values and expectations.

  • Technical support

    Help users solve problems on Discord

  • Content creation

    Write technical articles and guides

  • Tutorials

    Create step-by-step learning resources

  • Knowledge sharing

    Share expertise and best practices

  • Speaking

    Present at conferences and events

Development guide

Follow the development guide to get started with Plateforme development.

For your first contribution, we recommend reviewing issues labeled good-first-issue. These are carefully selected to help new contributors make meaningful contributions while learning our development process.

Development support

Need guidance? Our team is available on Discord to help you get started.