Skip to content

Improve README for better usability & discoverability of snippets #1671

Description

@Anudhyan

Hi team 👋

The repository is a great resource of ServiceNow code snippets. However, the current README is quite brief and doesn’t fully guide new users or contributors. I’d like to propose enhancing the README to make the repository more user-friendly and discoverable.

Proposed improvements:

Add a clear “How to use” section explaining how to find and use snippets in a ServiceNow instance.

Include an index/table of contents (or link to an index file) of all categories/snippets.

Document the folder structure and naming conventions.

Mention contribution guidelines prominently (link to CONTRIBUTING.md at the top).

Add tags/keywords or a small guide on how to search snippets by topic (e.g. GlideRecord, REST, UI).

These changes will make it easier for both newcomers and regular contributors to navigate the repo, and ensure snippets are used correctly.

Thanks for maintaining this awesome collection!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions