Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 3.28 KB

CONTRIBUTING_DOCS.md

File metadata and controls

91 lines (65 loc) · 3.28 KB

✒️ Contributing to Documentation

We are excited to have your help in improving our documentation! To ensure that we maintain high-quality and consistent documentation, please follow these guidelines:

🧑‍🏫 Guidelines for Writing Documentation

  1. Clarity and Accuracy:

    • Ensure that all content is clear, concise, and accurate.
    • Use simple language and avoid jargon unless it’s necessary and widely understood.

  2. Structure:

    • Organize the document logically with headings, subheadings, lists, and tables.
    • Use a consistent structure throughout the documentation to maintain readability.

  3. Consistency:

    • Adhere to the style guide provided in the CONTRIBUTING.md file.
    • Ensure that all examples, code snippets, and terminology are consistent with the rest of the documentation.

⏭️ Submitting Documentation Changes

  1. Fork the Repository:

    • Fork the repository to your own GitHub account if you haven't already.

  2. Create a New Branch:

    • Create a new branch for your documentation changes.
    git checkout -b docs/my-amazing-docs

  3. Make Changes:

    • Make the necessary updates to the documentation files located in the docs directory.

  4. Commit Your Changes:

    • Add your changes to the staging area and commit them with a descriptive message.
    git add .
git commit -m "Update documentation for classification head training"

  5. Push Your Changes:

    • Push your changes to your forked repository on GitHub.
    git push origin docs/my-amazing-docs

  6. Create a Pull Request:

    • Navigate to the original repository on GitHub and click on the "Pull Requests" tab.
    • Click on the "New Pull Request" button and compare against the main branch.
    • Fill out the pull request template with all relevant details, including a clear description of the changes made.

🤓 Code Review

  1. Address Feedback:

    • If a maintainer provides feedback on your pull request, address the comments and make necessary revisions.
    • Commit additional changes to your documentation branch and push them again.

  2. Maintain Consistency:

    • Ensure that all new or modified documentation is consistent with the existing content.
    • Use the same tone, style, and structure throughout the document.

🖨️ Example PR Template

Here’s an example of what a pull request template might look like for documentation changes:

PR Title: Update documentation for [specific topic]

Description:

  • Briefly describe the changes made to improve the documentation.
  • Explain why these changes are necessary.

Changes Made:

  • List the specific updates or additions made.
    • Added new section on [topic]
    • Updated example code in [section]
    • Corrected grammar and formatting throughout the document

Screenshots/Records (Optional):

  • Include any screenshots or recorded videos demonstrating the changes.

Reviewers:

  • Request reviews from specific individuals who can provide feedback.
    • @username1
    • @username2

By following these guidelines, we ensure that our documentation remains high-quality and useful for all users. Your contributions are greatly appreciated!

Thank you for helping to improve the Geophysical Foundation Model documentation!