Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#475)
Browse files Browse the repository at this point in the history
  • Loading branch information
chavda-bhavik authored Jan 29, 2024
2 parents e4ba9b1 + 86cddd3 commit 0e47a07
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Thank you for showing an interest in contributing to `Impler`! All kinds of cont

## Submitting an issue

Before submitting a new issue, please search the [issues](https://github.com/knovator/impler.io/issues) and [discussion](https://github.com/knovator/impler.io/discussions) tabs. Maybe an issue or discussion already exists and might inform you of workarounds. Otherwise, you can give new information.
Before submitting a new issue, please search the [issues](https://github.com/implerhq/impler.io/issues) and [discussion](https://github.com/implerhq/impler.io/discussions) tabs. Maybe an issue or discussion already exists and might inform you of workarounds. Otherwise, you can give new information.

While we want to fix all the [issues](https://github.com/knovator/impler.io/issues), before fixing a bug we need to be able to reproduce and confirm it. Please provide us with a minimal reproduction scenario using a repository or [Gist](https://gist.github.com/). Having a live, reproducible scenario gives us the information without asking questions back & forth with additional questions like:
While we want to fix all the [issues](https://github.com/implerhq/impler.io/issues), before fixing a bug we need to be able to reproduce and confirm it. Please provide us with a minimal reproduction scenario using a repository or [Gist](https://gist.github.com/). Having a live, reproducible scenario gives us the information without asking questions back & forth with additional questions like:

- What is failing or not working?
- Idea about context like `Self-Hosted`/`React`/`Iframe-embed` environment
- Steps to reproduce

You can open a new issue from [here](https://github.com/knovator/impler.io/issues/new).
You can open a new issue from [here](https://github.com/implerhq/impler.io/issues/new).

## Projects setup and Architecture

Expand All @@ -27,36 +27,36 @@ You can open a new issue from [here](https://github.com/knovator/impler.io/issue

The project is a monorepo, meaning that it is a collection of multiple packages managed in the same repository.

Follow these steps to setup the project locally,
Follow these steps to set up the project locally,

1. Clone the repo, git clone https://github.com/knovator/impler.io.
1. Clone the repo, git clone [https://github.com/implerhq/impler.io.git](https://github.com/implerhq/impler.io.git).
2. After cloning your fork,
1. Install the dependencies by running, `pnpm install`.
2. Do setup for projects by running, `pnpm setup:project`.
3. Start the application, `pnpm start:dev`.
4. Start interacting with API by visiting http://localhost:3000/api or see demo on http://localhost:5173.
4. Start interacting with web UI by visiting `http://localhost:4200`.

## Missing a Feature or Facing an issue?
## Missing a Feature or Facing an Issue?

If a feature is missing or you're experiencing issue, you can create issue [here](https://github.com/knovator/impler.io/issues/new).
If a feature is missing or you're experiencing an issue, you can report it [here](https://github.com/implerhq/impler.io/issues/new).

## Coding guidelines

To ensure consistency throughout the source code, please keep these rules in mind as you are working:

- All features or bug fixes must be tested by one or more specs (unit-tests).
- All features or bug fixes must be tested.
- We use [Eslint default rule guide](https://eslint.org/docs/rules/), with minor changes. An automated formatter is available using prettier.

## Need help? Questions and suggestions

Questions, suggestions, and thoughts are most welcome. Feel free to open a [GitHub Discussion](https://github.com/knovator/impler.io/discussions).
We can also be reached in our [Discord Server](https://discord.impler.io).
Questions, suggestions, and thoughts are most welcome. Feel free to open a [GitHub Discussion](https://github.com/implerhq/impler.io/discussions).
We can also be reached on our [Discord Server](https://discord.impler.io).

## Ways to contribute

- Try Importing file and platform and give feedback
- Help with open [issues](https://github.com/knovator/impler.io/issues) or [create your own](https://github.com/knovator/impler.io/issues/new)
- Share your thoughts and suggestions with us
- Use a platform and try importing files and share your thoughts
- Help with open [issues](https://github.com/implerhq/impler.io/issues) or [create your own](https://github.com/implerhq/impler.io/issues/new)
- Share your thoughts and suggestions with us over [discord](https://discord.impler.io)
- Help create tutorials and blog posts
- Request a feature by submitting a proposal
- Report a bug
Expand Down

0 comments on commit 0e47a07

Please sign in to comment.