Skip to content

Latest commit

 

History

History
86 lines (51 loc) · 3.66 KB

CONTRIBUTING.md

File metadata and controls

86 lines (51 loc) · 3.66 KB

Contributing Guide

Hello! We'd love to see your contribution on this repository soon, even if it's just a typo fix!

Contributing means anything from submitting blog post, reporting bugs, ideas, suggestion, code fix, even new feature.

JUMP STRAIGHT TO:

Add a blog post

You must fork this repository to your own Github account and clone it to your local device.

To make life easier, we provide a blog post template that you can fill out. Please fill out the metadata (title, description, author), so we can track the reader's analytics and the post performance. The post should be written in Markdown format.

If you have any confusion or burning questions, please reach out to the guys on Teknologi Umum's Telegram group.

Bug report, ideas and suggestion

The issues page is a great way to communicate to us. Other than that, we have a Telegram group that you can discuss your ideas into. If you're not an Indonesian speaker, it's 100% fine to talk in English there.

Please make sure that the issue you're creating is in as much detail as possible. Poor communication might lead to a big mistake, we're trying to avoid that.

Code fix and new feature

A big heads up before you're writing a breaking change code or a new feature: Please open up an issue regarding what you're working on, or just talk in the Telegram group.

Prerequisites

You will need a few things to get things working:

  1. Node.js current version (as of now, we're using v16.6.2 as defined in the .nvmrc file). You can install it through the official Node.js download page, but we recommend using nvm or fnm. Here's a simple installation/setup guide, but you should really refer directly to the corresponding repository's README.
# If you want to install fnm
$ curl -fsSL https://fnm.vercel.app/install | bash

# Then simply use this command
$ fnm use

# OR if you want to install nvm
$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash

$ nvm use

That's it actually.

Getting Started

  1. Fork this repository to your own Github account and clone it to your local device.
  2. Run npm install to install the dependencies needed.
  3. Run the development server with:
npm run dev
  1. Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

Directory structure

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Before creating a PR

Please run ESLint and Prettier with these commands so you're good on the CI/CD process.

$ npm run lint
$ npm run format

And you're set!