Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
santospatrick authored Sep 2, 2022
1 parent bf635cd commit 3b83533
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing to `santospatrick/nextjs-boilerplate-advanced`
> First of all thanks for having the will to help out 😇
## Getting Started

You should have experience in:
- React.js
- Next.js
- Typescript
- Chakra-UI

## Skills

- Developing applications in React including component design and state management
- Basic front end JavaScript/TypeScript experience
- General understanding of CI/CD pipelines (we use [Netlify](https://app.netlify.com/sites/sample-nextjs-app/deploys))

## Developing

1. [Fork this repo](https://github.com/santospatrick/nextjs-boilerplate-advanced/fork) into your account

2. Clone your new repo in your machine:

```bash
git clone https://github.com/your-username/nextjs-boilerplate-advanced.git
```

3. Open a new branch to start working in your changes:

```bash
git checkout -b feature/new-awesome-component
git push --set-upstream origin $(git_current_branch)
```

4. After you work in your changes, [open a new pull request](https://github.com/santospatrick/nextjs-boilerplate-advanced/compare)

5. Ask someone to review it (you can do it by adding "Reviewers" in your PR)

6. Wait and be patient with reviewers, as they might ask for some changes

7. Done 🎉

0 comments on commit 3b83533

Please sign in to comment.