Skip to content

Commit

Permalink
Format Pass: Making it right
Browse files Browse the repository at this point in the history
  • Loading branch information
JimTheCactus committed Oct 16, 2024
1 parent 2df5b3a commit 86c5b0e
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 28 deletions.
1 change: 0 additions & 1 deletion .github/workflows/docker-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,3 @@ jobs:
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

5 changes: 1 addition & 4 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---

name: NodeJS/NPM Release

on:
Expand All @@ -15,7 +14,6 @@ jobs:
runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v4
with:
token: ${{ secrets.GIT_REPO_ADMIN_PAT }}
Expand All @@ -27,7 +25,7 @@ jobs:
uses: actions/setup-node@v4
with:
node-version: 20.x
registry-url: 'https://registry.npmjs.org'
registry-url: "https://registry.npmjs.org"

- name: Get npm cache directory
id: npm-cache-dir
Expand Down Expand Up @@ -74,4 +72,3 @@ jobs:
PR_NUMBER=$(jq --raw-output .pull_request.number "$GITHUB_EVENT_PATH")
gh pr comment $PR_NUMBER -b "Created a new release version for this PR - [v${{ steps.bump-version.outputs.new-version }}](${{ github.event.repository.html_url }}/releases/tag/v${{ steps.bump-version.outputs.new-version }})"
11 changes: 4 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,18 @@ As you look to contribute here, please bear in mind our values, the 5 S's, and h

- Stateless: Be adaptable. Be open minded, and willing to try new things. Be willing to iterate, and comfortable with getting started when things are still ambiguous. Be informed and passionate, but flexible - strong opinions, weakly held.


## Reporting an Issue

There are a few types of issues you can file here:

- bug: Something doesn't work the way it should? That's probably a bug. Please include a careful, step-by-step guide to reproducing the bug, if possible. If reproducing the bug is hard to do without access to your environment, leave a note to that effect and we'll try to reach out for a private and secure conversation. If you have a security-sensitive ticket that you don't want to file publicly, please email ***insert security email address here*** instead of opening a ticket.
- bug: Something doesn't work the way it should? That's probably a bug. Please include a careful, step-by-step guide to reproducing the bug, if possible. If reproducing the bug is hard to do without access to your environment, leave a note to that effect and we'll try to reach out for a private and secure conversation. If you have a security-sensitive ticket that you don't want to file publicly, please email **_insert security email address here_** instead of opening a ticket.

- enhancement: Also known as Feature Requests, Enhancement tickets are for when you have something in mind that the Console Connect API Sandbox does not do but that you would like it to. Before filling out a feature request, we recommend you check our roadmap for features already planned.  If you don’t see it on there, go ahead and fill in a request.  Depending on your project and timelines, this may also be a great opportunity to try your hand at contributing to this project.

- question: we generally recommend that you use the Questions channel for general questions.  However, if you’re working on contributing code and have a question related to a ticket you picked up or a feature you’re developing, you can open a question ticket here for guidance and support.

- feedback: Not quite a feature request or a bug, but not really a question either? Feel free to leave general feedback here. We don't guarantee we'll act on all feedback, but we'll certainly read it.


## Writing Code

If you've got a pet peeve you want fixed, or a great idea for something to improve, here's your best bet for fixing it! We recommend you file a ticket according to reporting an issue above so there's a record of exactly what you're looking to fix, but once that's done we follow a fairly standard fork -> merge request model for community contributions.
Expand All @@ -70,12 +68,11 @@ Once you're ready to start, here are the steps to follow:

1. Fork the repo into your own namespace.

2. Make a branch for your work. We recommend using the Github "Open Pull Request" button 
2. Make a branch for your work. We recommend using the Github "Open Pull Request" button

3. Fill out the pull request template according to the steps in it - we're not ultra strict here, but it helps make our review process smoother.

4. Once you're ready for review, remove the 

4. Once you're ready for review, remove the

### What to expect from our code reviews

Expand All @@ -87,7 +84,7 @@ Testing deserves a special callout. In general, we don't want merge requests to

## What if I just have a question?

Great! We'll do our best to answer, you can reach us by ***input link or email address or other method for open source community to use for asking questions***.
Great! We'll do our best to answer, you can reach us by **_input link or email address or other method for open source community to use for asking questions_**.

## Thanks!

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

cc-api-sandbox is a mock server for the Console Connect API.

*Please, be aware that this repo is under heavy development, and should be expected to change rapidly.*
_Please, be aware that this repo is under heavy development, and should be expected to change rapidly._

## Installation

Expand Down
2 changes: 1 addition & 1 deletion eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export default tseslint.config(
"@typescript-eslint/no-unsafe-argument": "off",
"@typescript-eslint/no-unsafe-member-access": "off",
"@typescript-eslint/no-unsafe-assignment": "off",
}
},
},
// And specific rules for test code
{
Expand Down
30 changes: 16 additions & 14 deletions static/index.html
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
<!DOCTYPE html>
<!doctype html>
<html>
<head>
<title>cc-api-sandbox</title>
<style>
code {
<head>
<title>cc-api-sandbox</title>
<style>
code {
background-color: lightgray;
color: black;
padding: 0.1em 0.2em 0.1em 0.2em;
}
</style>
</head>
<body>
<h1>cc-api-sandbox</h1>
The API server is running and working correctly! You can use <code>curl -X "&lt;METHOD&gt;" http://127.0.0.1:9000/&lt;api path&gt;</code>
to access the API endpoints. As an example, you can use <code>curl -X "&lt;GET&gt;" http://127.0.0.1:9000/heartbeat</code> to get the
uptime and API version of the sandbox.
</body>
}
</style>
</head>
<body>
<h1>cc-api-sandbox</h1>
The API server is running and working correctly! You can use
<code>curl -X "&lt;METHOD&gt;" http://127.0.0.1:9000/&lt;api path&gt;</code>
to access the API endpoints. As an example, you can use
<code>curl -X "&lt;GET&gt;" http://127.0.0.1:9000/heartbeat</code> to get
the uptime and API version of the sandbox.
</body>
</html>

0 comments on commit 86c5b0e

Please sign in to comment.