Skip to content

Commit 663bdbb

Browse files
committed
Updated main repo readme
1 parent c21fa68 commit 663bdbb

File tree

1 file changed

+2
-62
lines changed

1 file changed

+2
-62
lines changed

README.md

Lines changed: 2 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,6 @@
1-
# 🚀 Cloudsmith CENG Template
1+
# 🚀 Cloudsmith Support Engineering
22

3-
A reusable template repository maintained by the **Customer Engineering (CENG)** team at Cloudsmith.
4-
This repo is intended to accelerate the development of examples, scripts, integrations, and demo workflows that help customers use Cloudsmith more effectively.
5-
6-
---
7-
8-
## 📦 What’s Inside
9-
10-
- GitHub Issue Forms for bugs and feature requests
11-
- CI/CD example workflow (Python-based)
12-
- Contribution and pull request templates
13-
- Environment variable and code linting examples
14-
- Directory structure for `src/` and `tests/`
15-
16-
---
17-
18-
## 📁 Structure
19-
20-
```
21-
.
22-
├── .github/ # GitHub-specific automation and templates
23-
│ ├── ISSUE_TEMPLATE/ # Issue forms using GitHub Issue Forms
24-
│ │ ├── bug_report.yml # Form for reporting bugs
25-
│ │ └── feature_request.yml # Form for suggesting features
26-
│ ├── workflows/ # GitHub Actions workflows (e.g., CI pipelines)
27-
│ ├── PULL_REQUEST_TEMPLATE.md # Template used when creating pull requests
28-
│ └── CODEOWNERS # Defines reviewers for specific paths
29-
├── src/ # Scripts, API integrations, or example tools
30-
├── tests/ # Tests for scripts and tools in src/
31-
├── .env.example # Sample environment config (e.g., API keys)
32-
├── .gitignore # Ignore rules for Git-tracked files
33-
├── .editorconfig # Code style config to ensure consistency across IDEs
34-
├── CHANGELOG.md # Log of project changes and version history
35-
├── CONTRIBUTING.md # Guidelines and checklists for contributors
36-
├── LICENSE # Licensing information (Apache 2.0)
37-
└── README.md # This file
38-
```
39-
40-
---
41-
42-
## 🛠 Getting Started
43-
44-
1. Clone the template:
45-
```bash
46-
git clone https://github.com/cloudsmith-examples/ceng-template.git
47-
cd ceng-template
48-
```
49-
50-
2. Install any dependencies or activate your environment.
51-
52-
3. Start building your example in the `src/` directory.
53-
54-
4. Use the `.env.example` as a guide for credentials if needed.
55-
56-
---
57-
58-
## 🧩 Use Cases
59-
60-
- Building and testing Cloudsmith integrations for CI/CD platforms
61-
- Creating reproducible customer issue examples
62-
- Building Cloudsmith CLI or API automations
63-
- Prototyping workflows for CI/CD platforms
3+
A collection of useful resources for assisting with various components of Cloudsmith.
644

655
---
666

0 commit comments

Comments
 (0)