Skip to content

Commit

Permalink
Merge branch 'release/0.1.1'
Browse files Browse the repository at this point in the history
  • Loading branch information
DominusKelvin committed Dec 5, 2023
2 parents f47e8fa + 7d1faa2 commit cf4a5c0
Show file tree
Hide file tree
Showing 21 changed files with 16,990 additions and 42 deletions.
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: DominusKelvin
patreon: dominuskelvin
36 changes: 29 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To contribute to The Boring JavScript Stack, follow these steps:

- Look at the existing [**Issues**](https://github.com/sailscastshq/boring-stack/issues) or create a new issue if you haven't found a suitable one.
- [**Fork the Repo**](https://github.com/sailscastshq/boring-stack/issues) and create a branch for the specific issue you are working on. Let's start making a difference together! 😊
- Create a **[Pull Request](https://github.com/sailscastshq/boring-stack)** (_PR_), which will be reviewed and given suggestions for improvements by the maintatiner.
- Create a **[Pull Request](https://github.com/sailscastshq/boring-stack)** (_PR_), which will be reviewed and given suggestions for improvements by the maintainer.
- If applicable, include screenshots or screen captures in your Pull Request to help us better understand the impact of your proposed changes.

---
Expand Down Expand Up @@ -62,17 +62,39 @@ This helps us track and automatically close the relevant issue when your Pull Re

### Commits

We highly encourage the use of conventional commits. Here are some examples:

- feat: Use this when adding a new feature.
- fix: Use this when resolving any issues in the codebase.
- chore: Use this when adding new links/resources or making minor changes.
(ex. chore: Add 'Privacy Policy' link in footer)
We highly encourage the use of conventional commits.

Your commit messages should contain one of these keywords based on the changes your make:

| Commit Type | Title | Description | Emoji(Optional) |
| ----------- | ------------------------ | ----------------------------------------------------------------------------------------------------------- |:------:|
| `feat` | Features | A new feature ||
| `fix` | Bug Fixes | A bug Fix | 🐛 |
| `docs` | Documentation | Documentation only changes | 📚 |
| `style` | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | 💎 |
| `refactor` | Code Refactoring | A code change that neither fixes a bug nor adds a feature | 📦 |
| `perf` | Performance Improvements | A code change that improves performance | 🚀 |
| `test` | Tests | Adding missing tests or correcting existing tests | 🚨 |
| `build` | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | 🛠 |
| `ci` | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | ⚙️ |
| `chore` | Chores | Other changes that don't modify src or test files | ♻️ |
| `revert` | Reverts | Reverts a previous commit | 🗑 |
[Source](https://github.com/pvdlg/conventional-commit-types)

Here are some examples:

- `feat: Implement user authentication feature`
- `fix: Null pointer exception when accessing user profile`
- `chore: Add 'Privacy Policy' link in footer`
- Please keep your commit messages concise and clear.
- Write commit messages in the present tense, as they represent the current state of the codebase after the changes have been applied.

For additional reference, check out [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

## First-time Contributor's Guide 📹

If you're a first-time contributor to open source projects, we recommend watching this [YouTube video](https://www.youtube.com/watch?v=Vqjzl9f3lGM). It provides valuable insights and guidance for getting started.

## Your Feedback Matters! 💬

- If you notice any missing information or feel that something is not adequately described, please don't hesitate to create a pull request (PR) or [raise an issue](https://github.com/sailscastshq/boring-stack/issues). Your input helps us improve our guidelines and make the Boring-Stack project even more awesome!
Expand Down
15 changes: 15 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### Description

...

### Current behavior

...

### Expected behavior

...

> Replace space in square bracket with `x` e.g `[x]`
[ ] I have checked and this issue does not exist
17 changes: 17 additions & 0 deletions PR_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### What issue did you solve?

The **issue** number:

The title:

### Summary
> Summarize the changes that have been made, provide screenshots if possible or recording
...

### Checklist
> Replace space in square bracket with an `x` e.g `[x]`
* [ ] No error in the console
* [ ] My code was tested before commit
* [ ] My repo was up to date before working on this commit
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "boring-stack",
"version": "0.1.0",
"version": "0.1.1",
"private": "true",
"description": "The Boring JavaScript Stack 🥱 - an opinionated project starter for fullstack JavaScript",
"scripts": {
Expand Down
10 changes: 3 additions & 7 deletions templates/mellow-react/assets/js/app.js
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
import React from 'react'
import { render } from 'react-dom'
import { createInertiaApp } from '@inertiajs/inertia-react'
import { InertiaProgress } from '@inertiajs/progress'
import { createInertiaApp } from '@inertiajs/react'
import { createRoot } from 'react-dom/client'
import '~/css/main.css'

InertiaProgress.init()

createInertiaApp({
resolve: (name) => require(`./pages/${name}`),
setup({ el, App, props }) {
render(<App {...props} />, el)
createRoot(el).render(<App {...props} />)
}
})
2 changes: 1 addition & 1 deletion templates/mellow-react/assets/js/pages/example.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Link } from '@inertiajs/inertia-react'
import { Link } from '@inertiajs/react'
export default function Hello({ quote }) {
return (
<div className="flex h-screen flex-col items-center justify-center space-y-8 text-center text-gray-700">
Expand Down
2 changes: 1 addition & 1 deletion templates/mellow-react/assets/js/pages/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Counter from '@/components/Counter'
import { Link } from '@inertiajs/inertia-react'
import { Link } from '@inertiajs/react'

export default function Index({ name }) {
return (
Expand Down
20 changes: 19 additions & 1 deletion templates/mellow-react/jsconfig.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
{
"include": ["api/**/*", "assets/js/**/*", "types/index.d.ts"],

"compilerOptions": {
"checkJs": true
"types": ["node"],
"typeRoots": ["./types", "./node_modules/@types"],
"lib": ["es2016"],
// silences wrong TS error, we don't compile, we only typecheck
"outDir": "./irrelevant/unused",
"allowJs": true,
"checkJs": true,
"jsx": "react-jsx",
"noImplicitThis": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noEmitOnError": true,
"noErrorTruncation": true,
"baseUrl": ".",
"paths": {
"@/*": ["assets/js/*"]
}
}
}
Loading

0 comments on commit cf4a5c0

Please sign in to comment.