Skip to content

Commit

Permalink
Merge branch 'pieces-app:main' into Implement-login-Logout-functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
VishalPawar1010 authored Jul 15, 2024
2 parents 70a734d + 2114db4 commit 8a5fb3b
Show file tree
Hide file tree
Showing 13 changed files with 319 additions and 716 deletions.
8 changes: 8 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"semi": true,
"singleQuote": true,
"trailingComma": "es5",
"printWidth": 80,
"tabWidth": 2,
"bracketSpacing": true
}
1 change: 1 addition & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @shivay-at-pieces @arindam-at-pieces @mason-at-pieces
58 changes: 55 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,60 @@ These are, in general, rules that you should be following while contributing to

2. Ensure that you have [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed.

### Prettier Setup

To ensure consistent code formatting across the project, we've integrated Prettier into our workflow. You can find more details about Prettier [Here](https://prettier.io/).

**1.** Configuration

We've included a .prettierrc file at the root of the project with the following configuration:

```json
{
"semi": true,
"singleQuote": true,
"trailingComma": "es5",
"printWidth": 80,
"tabWidth": 2,
"bracketSpacing": true
}
```

This will enforce consistent code formatting rules across the project, including semicolons, single quotes, trailing commas, line width, tab spacing, and bracket spacing.

**2.** Scripts in `package.json`

We've added the following scripts in `package.json`:

```json
{
"scripts": {
"format": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,css,scss,md}\"",
"format:check": "prettier --check \"src/**/*.{js,jsx,ts,tsx,json,css,scss,md}\""
}
}
```

These scripts automate code formatting (format) and checking (format:check) for JavaScript, TypeScript, JSX, JSON, CSS, SCSS, and Markdown files within the src directory.

**3.** Check Formatting

To verify code formatting without making any changes, run:

```bash
npm run format:check
```

**4.** Format Code

To format your code automatically, use the following npm script:

```bash
npm run format
```

These configurations automate code formatting and ensure consistent style across the project.

### Pull Request

**1.** Fork the [repository](https://github.com/pieces-app/example-typescript) on GitHub.
Expand Down Expand Up @@ -96,7 +150,6 @@ git push -u origin <YOUR_BRANCH_NAME>

**12.** Give a proper title to your PR and describe the changes you made in the description box. (Note: Sometimes there are PR templates that are to be filled in as instructed.)


**13.** Open a pull request by clicking the `Create pull request` button.

`Voila, you have made your first contribution to this project`
Expand Down Expand Up @@ -128,12 +181,11 @@ Check out these steps for uploading a **pdf export** into the `/mockups` folder:

1. Export your file from your design software as a .PDF file
2. After you have followed the above steps to fork the repo and download the project, open up the `/mockups` folder and locate either draft or final depending on your current status
3. Then save the PDF to one of the directories, and set the title in this pattern:
3. Then save the PDF to one of the directories, and set the title in this pattern:
- [date]_[pagename]_[authorname].pdf
4. Then commit your changes to your local branch, push those change and open up a PR! From there you should be all good to go.

### Tutorials that may help you:

- [Git & GitHub Tutorial](https://www.youtube.com/watch?v=RGOj5yH7evk)
- [Resolve merge conflict](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)

Loading

0 comments on commit 8a5fb3b

Please sign in to comment.