-
Notifications
You must be signed in to change notification settings - Fork 909
Revise README for clarity and community involvement #1772
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Revise README for clarity and community involvement #1772
Conversation
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. | ||
| [](CONTRIBUTING.md) | ||
| [](https://github.com/ServiceNowDevProgram/Hacktoberfest) | ||
| [](LICENSE) |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
| 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`) |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
Added section on contributing directly from the web without setup.
earlduque
left a comment
There was a problem hiding this 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.
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
Code Quality
Repository Structure Compliance
Core ServiceNow APIs/Server-Side Components/Client-Side Components/Modern Development/Integration/Specialized Areas/Documentation
Restrictions