Skip to content

Commit

Permalink
docs: minor fix in Contributing.md file
Browse files Browse the repository at this point in the history
Signed-off-by: Abhilipsa Sahoo <[email protected]>
  • Loading branch information
abhilipsasahoo03 authored Oct 6, 2022
1 parent 1a20dd8 commit 042f4fe
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for showing an interest in contributing to Novu! All kinds of contribu

## Submitting an issue

Before submitting a new issue, please search the issues and discussion tabs maybe an issue or discussion already exists and might inform you of workarounds, or you can give new information.
Before submitting a new issue, please search the issues and discussion 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, 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:

Expand All @@ -13,7 +13,7 @@ While we want to fix all the issues, before fixing a bug we need to be able to r

Without said minimal reproduction, we won't be able to investigate all issues, and the issue might not be resolved.

You can open a new issues with this new [issue form](https://github.com/novuhq/novu/issues/new).
You can open a new issue with this [issue form](https://github.com/novuhq/novu/issues/new).

## Projects setup and Architecture

Expand All @@ -40,12 +40,12 @@ To learn a detailed guide on running the project locally, visit [https://docs.no

## Missing a Feature?

If a feature is missing you can _request_ a new one by [submitting an issue](#submitting-an-issue) to our GitHub Repository.
If you would like to _implement_ it, an issue with your proposal must be submitted first, to be sure that we can use it. Please consider:
If a feature is missing, you can _request_ a new one by [submitting an issue](#submitting-an-issue) to our GitHub Repository.
If you would like to _implement_ it, an issue with your proposal must be submitted first, to be sure that we can use it. Please consider the guidelines given below.

## Coding guides
## Coding guidelines

To ensure consistency throughout the source code, keep these rules in mind as you are working:
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).
- We use [Eslint default rule guide](https://eslint.org/docs/rules/), with minor changes. An automated formatter is available using prettier.
Expand All @@ -58,10 +58,10 @@ Questions, suggestions and thoughts are most welcome. Feel free to open a [Githu

- Try the Novu API and platform and give feedback
- Add new providers
- Help with open issues
- Help with open issues or create your own
- Share your thoughts and suggestions with us
- Help create tutorials and blog posts
- Request a feature
- Request a feature by submitting a proposal
- Report a bug
- **Improve documentation** - fix incomplete or missing [docs](https://docs.novu.co/), bad wording, examples or explanations.

Expand Down

0 comments on commit 042f4fe

Please sign in to comment.