Skip to content

Commit

Permalink
Upgrade contributing (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
nelsonmestevao committed Jan 30, 2022
1 parent 548b241 commit 52d626b
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 56 deletions.
67 changes: 61 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,63 @@
# Contributing
[asdf-vm]: https://asdf-vm.com/

When contributing to this repository, please first discuss the change you wish
to make via issue, email, or any other method with the owners of this
repository before making a change.
# 🚀 Getting Started

Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it
in all your interactions with the project.
These instructions will get you a copy of the project up and running on your
local machine for development and testing purposes.

## 📥 Prerequisites

The following software is required to be installed on your system:

- [Node.js 16.13+](https://nodejs.org/en/download/)

We recommend using [asdf version manager][asdf-vm] to install and manage all the
programming languages' requirements.

## 🔧 Setup

Install all dependencies.

```
npm install
```

Then, create your local environment file and fill in all the required details.

```
cp -n .env.sample .env.local
```

## 🔨 Development

Starting the development server.

```
npm run develop
```

Test your code against common guidelines.

```
npm run test
```

Lint your code.

```
npm run lint
```

Format your code.

```
npm run format
```

## 🔗 References

You can use these resources to learn more about the technologies this project
uses.

- [Getting Started with React](https://reactjs.org/docs/getting-started.html)
- [Learn Next.js](https://nextjs.org/learn).
58 changes: 8 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,60 +6,18 @@

> :link: Mapping CeSIUM's website to shorter urls
## :rocket: Getting Started
## 🤝 Contributing

These instructions will get you a copy of the project up and running on your
local machine for development and testing purposes.
When contributing to this repository, please first discuss the change you wish
to make via discussions, issue, email, or any other method with the owners of
this repository before making a change.

### :inbox_tray: Prerequisites
Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it
in all your interactions with the project.

The following software is required to be installed on your system:
We have a [Contributing Guide][contributing] to help you getting started.

- [Node.js 16.13+](https://nodejs.org/en/download/)

Install all dependencies using `npm install`.

### :hammer: Development

Starting the development server.

```
npm run develop
```

Test your code against common guidelines.

```
npm run test
```

Lint your code.

```
npm run lint
```

Format your code.

```
npm run format
```

### :link: References

You can use these resources to learn more about the technologies this project
uses.

- [Getting Started with React](https://reactjs.org/docs/getting-started.html)
- [Learn Next.js](https://nextjs.org/learn).

## :handshake: Contributing

Please read [CONTRIBUTING][contributing] and [CODE_OF_CONDUCT][code_of_conduct]
for details on our code of conduct and the process for submitting pull requests
to us.

## :memo: License
## 📝 License

<img src=".github/brand/cesium-DARK.svg#gh-light-mode-only" width="300">
<img src=".github/brand/cesium-LIGHT.svg#gh-dark-mode-only" width="300">
Expand Down

1 comment on commit 52d626b

@vercel
Copy link

@vercel vercel bot commented on 52d626b Jan 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.