Skip to content

Commit abe5be7

Browse files
authored
Updated CONTRIBUTING.md and README.md to new structure
1 parent f5d616c commit abe5be7

File tree

2 files changed

+23
-13
lines changed

2 files changed

+23
-13
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
1-
# Introduction
2-
If you ever get stuck, you can find us over on the [SNDEVS](https://sndevs.com) community ([invite.sndevs.com](https://invite.sndevs.com)) in either the #hactoberfest channel or the #next-experience-uib-workspace channel.
3-
4-
Things you'll need:
5-
- A [ServiceNow Developer Instance](https://developer.servicenow.com/)
1+
# What does a good contribution look like?
2+
- Adding functionality from the Issues in this repository
3+
- Adding net new functionality
4+
- Fixing a bug
5+
- Making the component or page look better
66
# Contributing guidelines
77
- If you want to contribute changes to the Custom Component itself, be sure to go to the [sister repository](https://github.com/ServiceNowDevProgram/Menu-Generating-Operations-Program-Widget-Custom-Component) and work from there.
88
- Be sure to follow the installation instructions below so your page isn't empty.
99
- Do not make changes to the default page in this experience. Make sure you create a Variant and only make changes there. Don't make changes to other people's variants.
10-
# Installation instructions
11-
Follow these instructions to install the experience page and the menu builder component in your instance.
12-
13-
1. Open App Engine Studio and import this repository directly to your instance.
14-
2. Install the [Update Set provided in the Releases section of the sister repository](https://github.com/ServiceNowDevProgram/Menu-Generating-Operations-Program-Widget-Custom-Component/releases/tag/original).
15-
3. Search for `Hacktober23` in the Filter Navigation 
16-
1. **Menu Builder** – takes you to the page to play with the component 
17-
2. **UI Builder** – takes you to the UI Builder page for the Menu Builder page 
10+
- Pull request descriptions must be explicit and descriptive of what is being changed.
11+
- Changes that are not within the scope of the description will result in the entire PR being rejected.
12+
- Low-effort/spam Pull Requests will be marked as spam accordingly.

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ And lastly, this repository is part of a larger coordinated effort by the Servic
1515
- [What is this even for?](#what-is-this-even-for)
1616
- [What do i need to know?](#what-do-i-need-to-know)
1717
- [Information on Portal Experience menus](#some-information-on-portal-experience-menus)
18+
- [Installation Instructions](#installation-instructions)
1819
# What is this even for?
1920
You can create something called Portal Experiences in UI Builder, which are similar to Workspaces. They aren't currently a replacement for Angular Service Portal as of the writing of this repo, you can read more about this [on the Next Experience Community forum](https://www.servicenow.com/community/next-experience-articles/portal-experience-faqs/ta-p/2331979). These Portal Experiences have menus that are generated from JSON, and it's a pain to manage them right now. So Jesalyn and I decided to do something fun - why not learn how to make a custom component while simultaneously spending hundreds of hours making a solution for something that only mildly inconvenienced us? (And then submit it as a Creator Con lab!)
2021

@@ -44,3 +45,17 @@ Actions have similar behavior, which I haven't cataloged. Sometimes they show up
4445

4546
Visual of what i've figured out so far.
4647

48+
49+
# Installation instructions
50+
Follow these instructions to install the experience page and the menu builder component in your instance.
51+
52+
If you ever get stuck, you can find us over on the [SNDEVS](https://sndevs.com) community ([invite.sndevs.com](https://invite.sndevs.com)) in either the `#hactoberfest` channel or the `#next-experience-uib-workspace` channel.
53+
54+
Things you'll need:
55+
- A [ServiceNow Developer Instance](https://developer.servicenow.com/)
56+
57+
1. Open App Engine Studio and import this repository directly to your instance.
58+
2. Install the [Update Set provided in the Releases section of the sister repository](https://github.com/ServiceNowDevProgram/Menu-Generating-Operations-Program-Widget-Custom-Component/releases/tag/original).
59+
3. Search for `Hacktober23` in the Filter Navigation 
60+
1. **Menu Builder** – takes you to the page to play with the component 
61+
2. **UI Builder** – takes you to the UI Builder page for the Menu Builder page 

0 commit comments

Comments
 (0)