Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"presets": ["@babel/preset-env"],
"plugins": ["@babel/plugin-transform-modules-commonjs"]

}

"presets": ["@babel/preset-env"],
"plugins": ["@babel/plugin-transform-modules-commonjs"]
}
13 changes: 12 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
tests/*.test.js
node_modules/
.DS_Store
*.log
*.lock
*.env
.github/
.husky

*.md
*.MD

package-lock.json
36 changes: 19 additions & 17 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
{
"env": {
"browser": true,
"es2021": true
"env": {
"browser": true,
"es2021": true,
"jest/globals": true
},
"extends": ["eslint:recommended", "prettier"],
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"extends": ["eslint:recommended", "prettier"],
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": "latest",
"sourceType": "module"
},
"rules": {
"indent": ["warn", "tab"],
"quotes": ["error", "single"],
"semi": ["error", "always"]
}
}
"ecmaVersion": "latest",
"sourceType": "module"
},
"plugins": ["jest"],
"rules": {
"indent": ["warn", 2],
"quotes": ["error", "single"],
"semi": ["error", "always"]
}
}
30 changes: 30 additions & 0 deletions .github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 'CI/CD'
on:
push:
branches: [main]

pull_request:
types: [opened, reopened, synchronize, ready_for_review, labeled]
branches: [main]

workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
jest:
runs-on: ubuntu-latest
if: ${{ github.event_name == 'push' || contains(github.event.pull_request.labels.*.name, 'trigger-CI/CD') || !github.event.pull_request.draft }}

steps:
- name: Checkout Repository
uses: actions/checkout@v3

# Install npm dependencies
- name: Install Dependencies
run: npm install

- name: Run test
run: npm run test
16 changes: 8 additions & 8 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"tabWidth": 2,
"useTabs": true,
"printWidth": 80,
"semi": true,
"trailingComma": "es5",
"jsxSingleQuote": true,
"singleQuote": true
}
"tabWidth": 2,
"useTabs": false,
"printWidth": 80,
"semi": true,
"trailingComma": "es5",
"jsxSingleQuote": true,
"singleQuote": true
}
37 changes: 23 additions & 14 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
<br />

## 🚀 Start Here:

<br />

## 🛤️ Contribution Stations
## 🛤️ Contribution Stations

In the Stringy codebase, you'll find several "Contribution Stations". These are specially marked sections where we encourage contributions, particularly from those who are new to open source or to the project.
<br />
Expand All @@ -19,7 +20,8 @@ A Contribution Station is a segment of code, marked with a special comment, wher
- A clear description of what's needed.
- An example input and the expected output.
- A placeholder where you can write your code.
<br />
<br />

### Example:

```javascript
Expand All @@ -30,12 +32,14 @@ function stringReverse(string) {
// Write your code here and export it.
}
```

<br />

## 🧵 How to Contribute at a Station
## 🧵 How to Contribute at a Station

<br />

### Step 1: 👀 Find the Contribution Station suitable for you from Good First Issue
### Step 1: 👀 Find the Contribution Station suitable for you from Good First Issue

<br />
→ Begin by looking for issues tagged as 'good first issue'. These are great for getting warmed up!
Expand All @@ -45,7 +49,8 @@ function stringReverse(string) {
<br />
<br />

### Step 2: 🌿 Create a Branch
### Step 2: 🌿 Create a Branch

<br />

→ On the issue page, start by creating a branch. This keeps the main codebase safe while you make your changes.
Expand All @@ -55,7 +60,8 @@ function stringReverse(string) {
<br />
<br />

### Step 3: 🏡 Clone the Repo
### Step 3: 🏡 Clone the Repo

<br />

→ Clone the Stringy repository to your local machine and switch to your new branch to begin coding.
Expand All @@ -70,20 +76,22 @@ function stringReverse(string) {
<br />
<br />

### Step 4: 💾 Commit Your Changes
### Step 4: 💾 Commit Your Changes

<br />

→ Time to save your changes with a good commit message. Don't worry, it's just your branch.
<br />
<br />

### Step 5: ⬆️ Push Your Changes
### Step 5: ⬆️ Push Your Changes

→ Push your commits to your GitHub branch.
→ Push your commits to your GitHub branch.
<br />
<br />

### Step 6: 🔄 Back to GitHub Repo
### Step 6: 🔄 Back to GitHub Repo

<br />

→ Upon pushing your changes, you'll see an update in your repository with an option to create a Pull Request.
Expand All @@ -93,7 +101,8 @@ function stringReverse(string) {
<br />
<br />

### Step 7: ➕ Open a Pull Request
### Step 7: ➕ Open a Pull Request

<br />

→ Now, let the world see your work. Click on the green button or follow the next steps to open a Pull Request.
Expand All @@ -109,7 +118,7 @@ function stringReverse(string) {
<br />
<br />

### Step 8: 📬 PR Opened
### Step 8: 📬 PR Opened

→ Your PR is now waiting for review. Nice work!
<br />
Expand All @@ -119,10 +128,10 @@ function stringReverse(string) {
<br />
<br />

### Step 9: 🎉 Merge and Celebrate
### Step 9: 🎉 Merge and Celebrate

<br />

→ After your PR is reviewed and approved, it'll be merged. Congratulations, you're a Stringy contributor!

Now, take a moment like Pablo to enjoy your accomplishment. You've taken a big step in your open-source journey with Stringy. Keep it up! 🌟

Loading