Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (51 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 1.91 KB

Contributing to OMSF Website

Thank you for your interest in contributing to the OMSF website. This guide explains the process for making changes and additions to our website content.

For Content Contributors

If you are a member of the content contributors team, follow these steps:

  1. Create a new branch for your changes
  2. Make your edits
  3. Submit a pull request
  4. Wait for approval

Detailed Process

  1. Create a branch from main for your changes
  2. Make your edits using Markdown
  3. Create a pull request describing your changes
  4. Tag @zacharbake in the PR for review
  5. Address any feedback or requested changes
  6. Once approved, changes will be merged

Review Process

  • All changes require one approval before merging
  • Reviews will be completed within 24 hours
  • Reviewers may suggest changes or request clarification
  • Technical concerns will be reviewed by @ethanholz, if needed

For External Contributors

If you're not a member of the content contributors team but would like to suggest changes:

  1. Fork the repository
  2. Create a branch in your fork
  3. Make your changes
  4. Submit a pull request from your fork and tag @zacharbake
  5. Wait for review and approval

Content Guidelines

When contributing content:

  • Use clear, concise language
  • Follow existing formatting patterns
  • Include helpful commit messages
  • Test any links or references
  • Verify content accuracy
  • Remove any sensitive information

Getting Help

  • For content questions: Tag @zacharbake
  • For technical issues: Tag @ethanholz
  • For anything else, open an issue

Pull Request Template

When creating a pull request, please include:

  • Brief description of changes
  • Reason for changes
  • Areas affected
  • Any special considerations

Code of Conduct

  • Be respectful of other contributors
  • Follow the review process
  • Maintain website quality standards
  • Ask questions when unsure

Thank you for helping improve the OMSF website!