Skip to content

Commit f0393b1

Browse files
update codestruct and README.md
1 parent 5334553 commit f0393b1

File tree

2 files changed

+54
-3
lines changed

2 files changed

+54
-3
lines changed

.github/workflows/github-pages.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
runs-on: ubuntu-latest
2121
steps:
2222
- name: Checkout
23-
uses: actions/checkout@v3
23+
uses: actions/checkout@v4
2424
- name: Setup Pages
2525
uses: actions/configure-pages@v3
2626
- name: Build with Jekyll
@@ -29,7 +29,7 @@ jobs:
2929
source: ./
3030
destination: ./_site
3131
- name: Upload artifact
32-
uses: actions/upload-pages-artifact@v1
32+
uses: actions/upload-pages-artifact@v2
3333

3434
deploy:
3535
environment:
@@ -40,4 +40,4 @@ jobs:
4040
steps:
4141
- name: Deploy to GitHub Pages
4242
id: deployment
43-
uses: actions/deploy-pages@v1
43+
uses: actions/deploy-pages@v2

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# 🚀 Developers-101: Best Practices Hub
2+
3+
![GitHub Actions](https://img.shields.io/github/actions/workflow/status/Advanced-Infrastructure/developers-101/github-pages.yml?label=docs&style=flat-square)
4+
![Version](https://img.shields.io/badge/version-1.0.0-blue?style=flat-square)
5+
6+
> **The ultimate resource for development teams to collaborate seamlessly and maintain code quality**
7+
8+
## 🌟 Overview
9+
10+
This repository serves as a central knowledge base for development best practices, Git workflows, and code quality guidelines. Whether you're an experienced developer or just starting out, these resources will help you follow consistent standards across projects.
11+
12+
## 📚 Documentation
13+
14+
Our comprehensive documentation is available at:
15+
[https://advanced-infrastructure.github.io/developers-101/](https://advanced-infrastructure.github.io/developers-101/)
16+
17+
## 🧩 Key Features
18+
19+
- **Git Workflows**: Standardized branching strategies and commit conventions
20+
- **PR Guidelines**: Learn how to create effective PRs that are easy to review
21+
- **Team Conventions**: Team-specific naming conventions and workflows
22+
- **GitHub Automation**: CI/CD setup and branch protection rules
23+
24+
## 🗂️ What's Inside
25+
26+
- [Branch Protection Guidelines](./branch_protection.md)
27+
- [Pull Request Guidelines](./pr_guideline.md)
28+
29+
## 💻 Getting Started
30+
31+
1. Read through the documentation
32+
2. Reference these guidelines in your team's onboarding process
33+
3. Integrate these practices into your existing workflows
34+
35+
## 🤝 Contributing
36+
37+
We welcome contributions! If you have suggestions for improving these guidelines:
38+
39+
1. Fork the repository
40+
2. Create a feature branch (`git checkout -b feature/my-improvement`)
41+
3. Commit your changes (`git commit -am 'Add my improvement'`)
42+
4. Push to the branch (`git push origin feature/my-improvement`)
43+
5. Open a Pull Request
44+
45+
## 📜 License
46+
47+
This project is licensed under the MIT License - see the LICENSE file for details.
48+
49+
---
50+
51+
<p align="center">Made with ❤️ for developers who care about code quality</p>

0 commit comments

Comments
 (0)