|
1 | | -# .github Repository |
| 1 | +# 🏛️ Organization-wide GitHub configuration |
2 | 2 |
|
3 | | -This repository serves as the **community health repository** for the organization. It contains default files and templates that will apply across all repositories within the organization unless explicitly overridden. These files ensure consistency and maintain best practices across projects. |
| 3 | +This repository acts as the **community health repository** for the organization. It provides **default templates and guidelines** that apply automatically across all repositories, unless specifically overridden. Its purpose is to enforce best practices, promote consistency, and streamline contribution workflows. |
4 | 4 |
|
5 | | -## Repository Contents |
| 5 | +--- |
| 6 | + |
| 7 | +## 📦 Repository contents |
| 8 | + |
| 9 | +### 1. Issue and pull request templates 📝 |
| 10 | +Standardized templates to guide contributors and maintain clean, useful conversations. |
| 11 | + |
| 12 | +- `.github/ISSUE_TEMPLATE/bug_report.md` 🐛 – For reporting bugs |
| 13 | +- `.github/ISSUE_TEMPLATE/feature_request.md` ✨ – For feature suggestions |
| 14 | +- `.github/PULL_REQUEST_TEMPLATE.md` 🔄 – For submitting pull requests |
| 15 | + |
| 16 | +### 2. Code of conduct 🤝 |
| 17 | +Promotes a respectful and inclusive community across all organization projects. |
6 | 18 |
|
7 | | -### 1. **Issue and Pull Request Templates** 📝 |
8 | | -- **Purpose**: Streamline the contribution process by providing pre-defined templates for issues and pull requests. |
9 | | -- **Files**: |
10 | | - - `.github/ISSUE_TEMPLATE/bug_report.md` 🐛: Template for reporting bugs. |
11 | | - - `.github/ISSUE_TEMPLATE/feature_request.md` ✨: Template for requesting new features. |
12 | | - - `.github/PULL_REQUEST_TEMPLATE.md` 🔄: Template for submitting pull requests. |
| 19 | +- `CODE_OF_CONDUCT.md` |
13 | 20 |
|
14 | | -### 2. **Code of Conduct** 🤝 |
15 | | -- **Purpose**: Establish community guidelines to foster a respectful and inclusive environment. |
16 | | -- **File**: `CODE_OF_CONDUCT.md` |
| 21 | +### 3. Contributing guidelines 📜 |
| 22 | +Outlines how to contribute to organization repositories, including branch strategy and review processes. |
17 | 23 |
|
18 | | -### 3. **Contributing Guidelines** 📜 |
19 | | -- **Purpose**: Provide clear instructions for contributing to projects within the organization. |
20 | | -- **File**: `CONTRIBUTING.md` |
| 24 | +- `CONTRIBUTING.md` |
21 | 25 |
|
22 | | -### 4. **Security Policy** 🔒 |
23 | | -- **Purpose**: Define the process for reporting security vulnerabilities. |
24 | | -- **File**: `SECURITY.md` |
| 26 | +### 4. Security policy 🔒 |
| 27 | +Describes how to report vulnerabilities securely and responsibly. |
25 | 28 |
|
26 | | -## How It Works |
27 | | -The files in this repository are automatically applied to all repositories in the organization. However, any individual repository can override these defaults by providing its own corresponding file(s). |
| 29 | +- `SECURITY.md` |
28 | 30 |
|
29 | | -## Customization ✏️ |
30 | | -If your repository requires specific configurations or templates, you can: |
31 | | -- Add the required file(s) directly to your repository. |
32 | | -- Update the content to meet the specific needs of that project. |
| 31 | +--- |
| 32 | + |
| 33 | +## ⚙️ How it works |
| 34 | + |
| 35 | +GitHub automatically applies the files from this `.github` repository to **all organization repositories** unless they include their own versions of the same files. This ensures every project starts with solid community and contribution standards. |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +## ✏️ Customization |
| 40 | + |
| 41 | +To override or extend the defaults for a specific repository: |
| 42 | +- Add your custom file (e.g. `CONTRIBUTING.md`, `ISSUE_TEMPLATE`) to that repository. |
| 43 | +- GitHub will use the local version instead of the one in `.github`. |
| 44 | + |
| 45 | +--- |
| 46 | + |
| 47 | +## 🤗 Contributing |
| 48 | + |
| 49 | +We welcome improvements to these shared templates and guidelines! |
33 | 50 |
|
34 | | -## Contribution 🤗 |
35 | | -Contributions to improve this repository are welcome! To contribute: |
36 | 51 | 1. Fork this repository. |
37 | | -2. Make your changes in a new branch. |
38 | | -3. Submit a pull request with a detailed description of the changes. |
| 52 | +2. Create a new branch for your changes. |
| 53 | +3. Submit a pull request with a clear description of what you’re improving and why. |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +## 📄 License |
39 | 58 |
|
40 | | -## License 📄 |
41 | | -This repository and its contents are licensed under the [MIT License](LICENSE). |
| 59 | +This repository is licensed under the [MIT License](LICENSE). |
42 | 60 |
|
43 | 61 | --- |
44 | 62 |
|
45 | | -**Note**: For more information about GitHub community health files, visit the [official documentation](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file). |
| 63 | +> ℹ️ For more details about GitHub community health files, check out the [official GitHub documentation](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file). |
0 commit comments