diff --git a/.github/ISSUE_TEMPLATE/lesson_correction.yml b/.github/ISSUE_TEMPLATE/lesson_correction.yml new file mode 100644 index 0000000000..d3cd835b76 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/lesson_correction.yml @@ -0,0 +1,25 @@ +name: "✍️ Lesson Correction / Typo" +description: "Suggest corrections to spelling, broken links, or code errors in a lesson notebook" +title: "[Correction]: " +labels: ["bug", "documentation"] +body: + - type: markdown + attributes: + value: | + Thank you for helping us improve our lessons! Please fill out the form below. + - type: input + id: lesson_name + attributes: + label: "Lesson Name or File Path" + description: "Which week, lesson, or notebook file path contains the error?" + placeholder: "e.g., lessons/3-NeuralNetworks/03-Perceptron/README.md" + validations: + required: true + - type: textarea + id: error_details + attributes: + label: "Correction Details" + description: "Describe what is incorrect and what the correct spelling or code should be." + placeholder: "The link to the PyTorch docs in section 3 is broken, it should point to..." + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/translation_feedback.yml b/.github/ISSUE_TEMPLATE/translation_feedback.yml new file mode 100644 index 0000000000..4d6a44b217 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/translation_feedback.yml @@ -0,0 +1,74 @@ +name: "🌐 Translation Feedback" +description: "Suggest improvements or submit translations for a language" +title: "[Translation]: " +labels: ["translations"] +body: + - type: dropdown + id: language + attributes: + label: "Target Language" + options: + - Arabic (ar) + - Bengali (bn) + - Bulgarian (bg) + - Croatian (hr) + - Czech (cs) + - Danish (da) + - Dutch (nl) + - Estonian (et) + - Finnish (fi) + - French (fr) + - German (de) + - Greek (el) + - Hebrew (he) + - Hindi (hi) + - Hungarian (hu) + - Indonesian (id) + - Italian (it) + - Japanese (ja) + - Kannada (kn) + - Khmer (km) + - Korean (ko) + - Lithuanian (lt) + - Malay (ms) + - Malayalam (ml) + - Marathi (mr) + - Burmese (my) + - Nepali (ne) + - Nigerian Pidgin (pcm) + - Norwegian (no) + - Persian (fa) + - Polish (pl) + - Portuguese - Brazil (pt-BR) + - Portuguese - Portugal (pt-PT) + - Punjabi (pa) + - Romanian (ro) + - Russian (ru) + - Serbian (sr) + - Slovak (sk) + - Slovenian (sl) + - Spanish (es) + - Swahili (sw) + - Swedish (sv) + - Tamil (ta) + - Telugu (te) + - Thai (th) + - Tagalog (tl) + - Turkish (tr) + - Ukrainian (uk) + - Urdu (ur) + - Vietnamese (vi) + - Simplified Chinese (zh-CN) + - Traditional Chinese - Hong Kong (zh-HK) + - Traditional Chinese - Macao (zh-MO) + - Traditional Chinese - Taiwan (zh-TW) + - Other (please specify in details) + validations: + required: true + - type: textarea + id: details + attributes: + label: "Details" + description: "Specify the translation feedback, grammatical fixes, or new translation files you plan to submit." + validations: + required: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..dfff93ee21 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing to AI-For-Beginners + +Thank you for your interest in contributing to AI-For-Beginners! We welcome translations, lesson fixes, and formatting corrections. + +## Microsoft Contributor License Agreement (CLA) + +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.microsoft.com](https://cla.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., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA. + +## How to Contribute + +### 1. Fixing Typos / Code Errors +If you find a typo or bug in any Jupyter notebook or lesson markdown file: +1. Fork the repository. +2. Fix the typo or broken link. +3. Submit a Pull Request with a clear description of the fix. + +### 2. Submitting Translations +We welcome translations of the lessons into other languages! Please place translations under the `translations/` directory using the existing folder names there (for example `translations/es/`, `translations/pt-BR/`, `translations/zh-CN/`). + +For more details, see [etc/CONTRIBUTING.md](etc/CONTRIBUTING.md).