Skip to content

Commit 0b63a24

Browse files
Revise README for clarity and community involvement
Updated the README to enhance community engagement and clarify repository usage.
1 parent f8120aa commit 0b63a24

File tree

1 file changed

+157
-33
lines changed

1 file changed

+157
-33
lines changed

README.md

Lines changed: 157 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,190 @@
1-
![Code Snippets Banner](https://github.com/ServiceNowDevProgram/code-snippets/assets/31702109/f9fa072a-4c0c-426b-8eed-200c6616ff60)
1+
# 🚀 ServiceNow Code Snippets
22

3-
Welcome to ServiceNow's Code Snippets community repository, managed by the Developer Program and the sndevs Slack community.
3+
<div align="center">
44

5-
Inside this repository, you will find community submitted code-snippets and their variants for different use-cases.
5+
![Code Snippets Banner](https://github.com/ServiceNowDevProgram/code-snippets/assets/31702109/f9fa072a-4c0c-426b-8eed-200c6616ff60)
66

7-
> Interested in our other ServiceNow Hacktoberfest projects? See the main repository [here](https://github.com/ServiceNowDevProgram/Hacktoberfest) or see our official blog post [here](https://devlink.sn/hacktoberfest).
7+
**A community-driven collection of ServiceNow code snippets and solutions**
88

9-
**Note:** ServiceNowDevProgram has many repositories that can be imported directly into ServiceNow, this is not one of them; This repository is meant to be edited directly in GitHub or any other Git-enabled IDE like VS Code.
9+
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md)
10+
[![Hacktoberfest](https://img.shields.io/badge/Hacktoberfest-Participating-orange?style=flat-square)](https://github.com/ServiceNowDevProgram/Hacktoberfest)
11+
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
1012

11-
## Disclaimer
13+
[Explore Snippets](#-repository-structure) · [Contribute](#-how-to-contribute) · [Join Community](https://sndevs.com)
1214

13-
Please note the following:
15+
</div>
1416

15-
1. **Community-Sourced Code**: The code found in this repository is contributed by members of the community and has not been vetted or officially endorsed by the repository owners.
17+
---
1618

17-
2. **Use at Your Own Risk**: Users are advised to exercise caution and thoroughly review the code before implementing it in their ServiceNow instances. We strongly recommend a comprehensive review to ensure the code aligns with your specific requirements and security standards.
19+
## 📖 About
1820

19-
3. **Reporting Mistakes and Issues**: If you come across any mistakes, issues, or improvements in the code, we encourage you to report them and consider contributing to the repository by submitting corrections or enhancements.
21+
Welcome to the **ServiceNow Code Snippets** repository - your go-to resource for practical, real-world ServiceNow code examples. Managed by the ServiceNow Developer Program and the vibrant **sndevs** Slack community, this repository features battle-tested code snippets submitted by developers like you.
2022

21-
4. **No Warranty or Support**: This repository is provided as-is, without any warranties or guarantees. It does not come with official support from the ServiceNow team or the repository owners.
23+
> 🎃 **Hacktoberfest Participant**: Check out our [main Hacktoberfest repository](https://github.com/ServiceNowDevProgram/Hacktoberfest) and [official blog post](https://devlink.sn/hacktoberfest) for more projects!
2224
23-
By using the code from this repository, you acknowledge that you have read and understood this disclaimer. Your use of the code is at your own discretion and risk.
25+
### ✨ What Makes This Repository Special
2426

25-
We appreciate your participation and contributions to this community-driven project. Let's collaborate to make it a valuable resource for ServiceNow developers and enthusiasts.
27+
- 🌍 **Community-Powered**: Real solutions from real developers
28+
- 📚 **Comprehensive**: Covers all aspects of ServiceNow development
29+
- 🔄 **Always Growing**: Regular updates and new snippets
30+
- 🎯 **Practical**: Code you can actually use in production
31+
- 🤝 **Collaborative**: Built by developers, for developers
2632

27-
🔔🔔🔔<br>
28-
**_CONTRIBUTORS must follow all guidelines in [CONTRIBUTING.md](CONTRIBUTING.md)_** or run the risk of having your Pull Requests labeled as spam.<br>
29-
🔔🔔🔔
33+
---
3034

31-
## Repository Organization
35+
## 🗂️ Repository Structure
3236

33-
The repository is organized into **6 major categories** that cover all aspects of ServiceNow development:
37+
<table>
38+
<tr>
39+
<td width="50%">
3440

3541
### 📚 [Core ServiceNow APIs](Core%20ServiceNow%20APIs/)
36-
Essential ServiceNow JavaScript APIs and classes including GlideRecord, GlideAjax, GlideSystem, GlideDate, GlideDateTime, and other foundational APIs.
42+
Essential JavaScript APIs and classes
43+
- GlideRecord & GlideAjax
44+
- GlideSystem & GlideUser
45+
- GlideDate & GlideDateTime
46+
- Core utility functions
3747

3848
### ⚙️ [Server-Side Components](Server-Side%20Components/)
39-
Server-side code including Background Scripts, Business Rules, Script Includes, Scheduled Jobs, Transform Map Scripts, and other server-executed components.
49+
Server-executed code patterns
50+
- Background Scripts
51+
- Business Rules & ACLs
52+
- Script Includes
53+
- Scheduled Jobs & Transform Maps
4054

4155
### 🖥️ [Client-Side Components](Client-Side%20Components/)
42-
Client-side code including Client Scripts, Catalog Client Scripts, UI Actions, UI Scripts, UI Pages, and UX framework components.
56+
Browser-based functionality
57+
- Client Scripts & UI Policies
58+
- Catalog Client Scripts
59+
- UI Actions & UI Scripts
60+
- UX Framework components
61+
62+
</td>
63+
<td width="50%">
4364

4465
### 🚀 [Modern Development](Modern%20Development/)
45-
Modern ServiceNow development approaches including Service Portal, NOW Experience Framework, GraphQL implementations, and ECMAScript 2021 features.
66+
Contemporary ServiceNow approaches
67+
- Service Portal widgets
68+
- NOW Experience Framework
69+
- GraphQL implementations
70+
- ECMAScript 2021+ features
4671

4772
### 🔗 [Integration](Integration/)
48-
External system integrations, data import/export utilities, RESTMessageV2 examples, Mail Scripts, MIDServer utilities, and attachment handling.
73+
External system connectivity
74+
- REST & SOAP integrations
75+
- Mail Scripts & Webhooks
76+
- MIDServer utilities
77+
- Attachment handling
4978

5079
### 🎯 [Specialized Areas](Specialized%20Areas/)
51-
Domain-specific functionality including CMDB utilities, ITOM scripts, Performance Analytics, ATF Steps, Agile Development tools, and other specialized use cases.
80+
Domain-specific solutions
81+
- CMDB & Discovery
82+
- ITOM & Performance Analytics
83+
- ATF Steps & Test utilities
84+
- Agile Development tools
85+
86+
</td>
87+
</tr>
88+
</table>
89+
90+
---
91+
92+
## 🚀 How to Contribute
93+
94+
We'd love your contributions! Here's how to get started:
95+
96+
### Quick Start
97+
98+
1. **Fork** this repository (you get a point just for forking! 🎉)
99+
2. **Create** a new branch (`git checkout -b feature/amazing-snippet`)
100+
3. **Add** your code snippet following our [structure guidelines](CONTRIBUTING.md)
101+
4. **Commit** your changes (`git commit -m 'Add amazing snippet for X'`)
102+
5. **Push** to your branch (`git push origin feature/amazing-snippet`)
103+
6. **Open** a Pull Request
104+
105+
### 📝 Contribution Guidelines
106+
107+
> 🔔 **IMPORTANT**: All contributors **must** follow the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md) or risk having PRs labeled as spam.
108+
109+
**Key Points:**
110+
- Follow the existing folder structure
111+
- Include clear documentation and comments
112+
- Provide real-world use cases
113+
- Test your code before submitting
114+
- Use descriptive commit messages
115+
116+
**Not sure where to start?** Check out issues labeled `good-first-issue` or `help-wanted`!
117+
118+
---
119+
120+
## ⚠️ Important Disclaimer
121+
122+
<details>
123+
<summary>Click to read full disclaimer</summary>
124+
125+
### Community-Sourced Content
126+
127+
**Please note the following:**
128+
129+
1. **Not Officially Endorsed**: Code in this repository is community-contributed and not officially vetted or endorsed by ServiceNow or repository owners.
130+
131+
2. **Use at Your Own Risk**: Always review code thoroughly before implementing in your ServiceNow instances. Test in sub-production environments first.
132+
133+
3. **Report Issues**: Found a bug or improvement? Please [open an issue](../../issues) or submit a correction.
134+
135+
4. **No Warranty**: This repository is provided "as-is" without warranties or guarantees. No official support is provided.
136+
137+
5. **Security First**: Always validate code against your organization's security standards before deployment.
138+
139+
**By using code from this repository, you acknowledge you've read and understood this disclaimer.**
140+
141+
</details>
142+
143+
---
144+
145+
## 🏆 Recognition
146+
147+
View our contributor leaderboard and stats in the [Hacktoberfest repository](https://github.com/ServiceNowDevProgram/Hacktoberfest#leaders)!
148+
149+
---
150+
151+
## 🌐 Community & Resources
152+
153+
<div align="center">
154+
155+
| Resource | Description |
156+
|----------|-------------|
157+
| [sndevs Slack](https://sndevs.com) | Join thousands of ServiceNow developers |
158+
| [Developer Portal](https://developer.servicenow.com) | Official ServiceNow documentation |
159+
| [Community Forum](https://www.servicenow.com/community/) | Ask questions and share knowledge |
160+
| [Developer Blog](https://developer.servicenow.com/blog.do) | Latest news and tutorials |
161+
162+
</div>
163+
164+
---
165+
166+
## 📄 License
167+
168+
This repository is available under the MIT License. See [LICENSE](LICENSE) for more details.
169+
170+
---
171+
172+
## 🙏 Acknowledgments
173+
174+
Special thanks to:
175+
- All our amazing [contributors](../../graphs/contributors)
176+
- The ServiceNow Developer Program team
177+
- The sndevs community moderators
178+
- Everyone who has starred, forked, or shared this project
52179

53-
## We invite you to contribute!
180+
---
54181

55-
To contribute, just follow these steps:
182+
<div align="center">
56183

57-
1. Fork this repo (you get a point just by forking!)
58-
2. Create a new branch on your fork
59-
3. Add/Update the repo
60-
4. Submit a pull request!
184+
**⭐ Star this repo if you find it helpful!**
61185

62-
That's it! More detailed contribution instructions can be found [here](CONTRIBUTING.md)
186+
Made with ❤️ by the ServiceNow Developer Community
63187

64-
## Leaderboard
188+
[Report Bug](../../issues) · [Request Feature](../../issues) · [View Statistics](../../pulse)
65189

66-
Looking for the old leaderboard? We've moved the leaderboard to the overarching [Hacktoberfest](https://github.com/ServiceNowDevProgram/Hacktoberfest#leaders) repository and have expanded its scope to all participating projects.
190+
</div>

0 commit comments

Comments
 (0)