Skip to content

Contributing to EPICURE Documentation

We welcome contributions to improve the EPICURE documentation! This guide provides instructions on how to contribute effectively.

Getting Started

  1. Fork the Repository
  2. Fork the EPICURE documentation repository

  3. Clone your fork locally

  4. Set Up Your Environment 

    # Install dependencies
pip install -r requirements.txt

# Build the documentation locally
mkdocs build

Documentation Structure

The documentation is organized as follows:

docs/
├── articles/                 # Main documentation articles
│   ├── best-practices/      # Best practices guides
│   ├── code-snippets/       # Code examples
│   └── how-to/             # How-to guides
├── contributing.md          # This file
└── index.md                # Main documentation page

Writing Guidelines

Style and Formatting

  1. Markdown Format
  2. Use proper Markdown formatting
  3. Keep lines under 80 characters

  4. Use consistent heading levels

  5. Code Examples 

    // Use proper code blocks with language tags
MPI_Init(&argc, &argv);

  6. Links

  7. Use relative paths
  8. Keep links consistent
  9. Test links before committing

Content Guidelines

  1. Technical Accuracy
  2. Verify all technical information
  3. Include version numbers

  4. Test code examples

  5. Clarity

  6. Write clearly and concisely
  7. Use examples where appropriate

  8. Include relevant links

  9. Consistency

  10. Follow existing style
  11. Use consistent terminology
  12. Maintain consistent formatting

Submitting Changes

  1. Create a Branch 

    git checkout -b feature/your-feature

  2. Commit Your Changes 

    git add .
git commit -m "Add feature documentation"

  3. Push to Fork 

    git push origin feature/your-feature

  4. Create Pull Request

  5. Go to the original repository
  6. Click "New Pull Request"
  7. Select your branch
  8. Fill in the PR template

Review Process

  1. Initial Review
  2. Documentation team reviews content
  3. Checks for technical accuracy

  4. Ensures style consistency

  5. Feedback

  6. Reviewers provide feedback
  7. Request changes if needed

  8. Discuss improvements

  9. Final Review

  10. Final technical review
  11. Style check
  12. Merge approval

Code of Conduct

All contributors are expected to follow our Code of Conduct:

  1. Be Respectful
  2. Treat everyone with respect
  3. Be open to feedback

  4. Maintain a positive attitude

  5. Be Professional

  6. Keep discussions professional
  7. Avoid personal attacks

  8. Focus on technical merit

  9. Be Collaborative

  10. Work together
  11. Help each other
  12. Share knowledge

Getting Help

If you need help:

  1. Documentation Issues
  2. Open an issue in the repository
  3. Include relevant details

  4. Be specific about the problem

  5. Technical Questions

  6. Join our community forum
  7. Ask questions in the appropriate channel

  8. Include relevant information

  9. Contributing Help

  10. Contact the documentation team
  11. Ask for guidance
  12. Get help with technical details

Thank You

Thank you for contributing to the EPICURE documentation! Your contributions help make the documentation better for everyone.

License

By contributing to this documentation, you agree that your contributions will be licensed under the project's license.