Skip to content

Latest commit

 

History

History
128 lines (81 loc) · 7.35 KB

CONTRIBUTING.md

File metadata and controls

128 lines (81 loc) · 7.35 KB
Raw

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information read the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Cautions for creating issues

Please do not open GitHub issues for general support questions as the GitHub list should be used for feature requests and bug reports. This way we can more easily track actual issues or bugs from the code and keep the general discussion separate from the actual code.

How to Contribute

Pull Requests Guidelines

When submitting a pull request (PR) to the Phi-3 CookBook repository, please use the following guidelines:

  • Fork the Repository: Always fork the repository to your own account before making your modifications.

  • Separate pull requests (PR):

    • Submit each type of change in its own pull request. For example, bug fixes and documentation updates should be submitted in separate PRs.
    • Typo fixes and minor documentation updates can be combined into a single PR where appropriate.

  • Handle merge conflicts: If your pull request shows merge conflicts, update your local main branch to mirror the main repository before making your modifications.

  • Translation submissions: When submitting a translation PR, ensure that the translation folder includes translations for all files in the original folder.

Translation Guidelines

Important

When translating text in this repository, do not use machine translation. Only volunteer for translations in languages where you are proficient.

If you are proficient in a non-English language, you can help translate the content. Follow these steps to ensure your translation contributions are properly integrated, please use the following guidelines:

  • Create translation folder: Navigate to the appropriate section folder and create a translation folder for the language you are contributing to. For example:

    • For the introduction section: Phi-3CookBook/md/01.Introduce/translations/<language_code>/
    • For the quick start section: Phi-3CookBook/md/02.QuickStart/translations/<language_code>/
    • Continue this pattern for other sections (03.Inference, 04.Finetuning, etc.)

  • Update relative paths: When translating, adjust the folder structure by adding ../../ to the beginning of relative paths within the markdown files to ensure links work correctly. For example, change as following:

    • Change (../../imgs/01/phi3aisafety.png) to (../../../../imgs/01/phi3aisafety.png)

  • Organize your translations: Each translated file should be placed in the corresponding section's translation folder. For example, if you are translating the introduction section into Spanish, you would create as following:

    • Phi-3CookBook/md/01.Introduce/translations/es/

  • Submit a complete PR: Ensure all translated files for a section are included in one PR. We do not accept partial translations for a section. When submitting a translation PR, make sure that the translation folder includes translations for all files in the original folder.

Writing Guidelines

To ensure consistency across all documents, please use the following guidelines:

  • URL formatting: Wrap all URLs in square brackets followed by parentheses, without any extra spaces around or inside them. For example: [example](https://example.com).

  • Relative links: Use ./ for relative links pointing to files or folders in the current directory, and ../ for those in a parent directory. For example: [example](./path/to/file) or [example](../path/to/file).

  • Not Country-Specific locales: Ensure that your links do not include country-specific locales. For example, avoid /en-us/ or /en/.

  • Image storage: Store all images in the ./imgs folder.

  • Descriptive image names: Name images descriptively using English characters, numbers, and dashes. For example: example-image.jpg.

GitHub Workflows

When you submit a pull request, the following workflows will be triggered to validate the changes. Follow the instructions below to ensure your pull request passes the workflow checks:

Check Broken Relative Paths

This workflow ensures that all relative paths in your files are correct.

  1. To make sure your links are working properly, perform the following tasks using VS Code:

    • Hover over any link in your files.
    • Press Ctrl + Click to navigate to the link.
    • If you click on a link and it doesn't work locally, it will trigger the workflow and not work on GitHub.

  2. To fix this issue, perform the following tasks using the path suggestions provided by VS Code:

    • Type ./ or ../.
    • VS Code will prompt you to choose from the available options based on what you typed.
    • Follow the path by clicking on the desired file or folder to ensure your path is correct.

Once you have added the correct relative path, save and push your changes.

Check URLs Don't Have Locale

This workflow ensures that any web URL doesn't include a country-specific locale. As this repository is accessible globally, it is important to ensure that URLs do not contain your country's locale.

  1. To verify that your URLs don't have country locales, perform the following tasks:

    • Check for text like /en-us/, /en/, or any other language locale in the URLs.
    • If these are not present in your URLs, then you will pass this check.

  2. To fix this issue, perform the following tasks:

    • Open the file path highlighted by the workflow.
    • Remove the country locale from the URLs.

Once you remove the country locale, save and push your changes.

Check Broken Urls

This workflow ensures that any web URL in your files is working and returning 200 status code.

  1. To verify that your URLs are working correctly, perform the following tasks:

    • Check the status of the URLs in your files.

  2. To fix any broken URLs, perform the following tasks:

    • Open the file that contains the broken URL.
    • Update the URL to the correct one.

Once you have fixed the URLs, save and push your changes.

Note

There may be cases where the URL check fails even though the link is accessible. This can happen for several reasons, including:

  • Network restrictions: GitHub actions servers may have network restrictions that prevent access to certain URLs.
  • Timeout issues: URLs that take too long to respond may trigger a timeout error in the workflow.
  • Temporary server issues: Occasional server downtime or maintenance can make a URL temporarily unavailable during validation.