Skip to content

Conversation

@AyanAhmedKhan
Copy link
Contributor

@AyanAhmedKhan AyanAhmedKhan commented Oct 4, 2025

Updated the README to enhance community engagement and clarify repository usage.

PR Description:

This PR updates the README.md to improve clarity, readability, and contributor onboarding. It adds visual enhancements (badges, headers), expands the "About" and "How to Contribute" sections, improves navigation, and highlights community resources, while preserving all original content and repository structure.

Pull Request Checklist

Overview

  • I have read and understood the CONTRIBUTING.md guidelines
  • My pull request has a descriptive title that accurately reflects the changes
  • I've included only files relevant to the changes described in the PR title and description
  • I've created a new branch in my forked repository for this contribution

Code Quality

  • My code is relevant to ServiceNow developers
  • My code snippets expand meaningfully on official ServiceNow documentation (if applicable)
  • I've disclosed use of ES2021 features (if applicable)
  • I've tested my code snippets in a ServiceNow environment (where possible)

Repository Structure Compliance

  • I've placed my code snippet(s) in one of the required top-level categories:
    • Core ServiceNow APIs/
    • Server-Side Components/
    • Client-Side Components/
    • Modern Development/
    • Integration/
    • Specialized Areas/
  • I've used appropriate sub-categories within the top-level categories
  • Each code snippet has its own folder with a descriptive name

Documentation

  • I've included a README.md file for each code snippet
  • The README.md includes:
    • Description of the code snippet functionality
    • Usage instructions or examples
    • Any prerequisites or dependencies
    • (Optional) Screenshots or diagrams if helpful

Restrictions

  • My PR does not include XML exports of ServiceNow records
  • My PR does not contain sensitive information (passwords, API keys, tokens)
  • My PR does not include changes that fall outside the described scope

Updated the README to enhance community engagement and clarify repository usage.
README.md Outdated
**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.
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md)
[![Hacktoberfest](https://img.shields.io/badge/Hacktoberfest-Participating-orange?style=flat-square)](https://github.com/ServiceNowDevProgram/Hacktoberfest)
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This repo does not currently have a license, so this needs to be removed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SapphicFire i have done the changes and please review it

README.md Outdated
Comment on lines 99 to 102
2. **Create** a new branch (`git checkout -b feature/amazing-snippet`)
3. **Add** your code snippet following our [structure guidelines](CONTRIBUTING.md)
4. **Commit** your changes (`git commit -m 'Add amazing snippet for X'`)
5. **Push** to your branch (`git push origin feature/amazing-snippet`)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, please also include web instructions

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SapphicFire i have included the web instructions

AyanAhmedKhan and others added 2 commits October 5, 2025 17:59
Added section on contributing directly from the web without setup.
Copy link
Contributor

@earlduque earlduque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Due to a competing PR by another user, I've manually edited your readme file to accept the changes that we like.

@earlduque earlduque merged commit 2b1ed07 into ServiceNowDevProgram:main Oct 5, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants