Skip to content

Commit

Permalink
fix: howto doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rsaz committed Sep 17, 2023
1 parent e98a374 commit 2e4ae5a
Showing 1 changed file with 30 additions and 22 deletions.
52 changes: 30 additions & 22 deletions CONTRIBUTING_HOWTO.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# How to contribute to ExpressoTS
# How to Contribute to ExpressoTS

1. [Fork](https://github.com/expressots/expresso-site-doc/fork) the repo and create your branch from main.
1. [Fork](https://github.com/expressots/expressots-cli/fork) the repo and create your branch from main.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## Installation Guide
## How to Contribute to the Documentation

We are currently using Docusaurus version 2.4.1. For more information about Docusaurus, please visit the [Docusaurus website](https://docusaurus.io/docs)

After forking the repo, you can install the dependencies with the following command:
Follow the steps above from 1 to 6. In addition execute the following commands:

```bash
npm install
Expand All @@ -23,37 +23,23 @@ And run the project in development mode with:
npm start
```

## Report an issue or a bug

If you find a bug in the source code, you can help us by submitting an issue in the **[Issue reporting channel](https://github.com/expressots/expressots/issues)**. Event better, you can submit a **[Pull Request](https://github.com/expressots/expressots/pulls)** with a fix.

## Request a feature

You can request a new feature by submitting an issue in the **[Issue reporting channel](https://github.com/expressots/expressots/issues)**.

If you would like to implement the new feature, please submit an issue describing your proposal first. Thi will allow us to provide feedback, ensure that the feature is aligned with the project goals and that you are not duplicating work.

## Issues and Feature Requests Labels
### [ Doc ] Issues and Feature Requests Labels

- **[doc fix]**: A documentation fix
- **[doc update]**: A documentation update
- **[feature]**: A new feature
- **[new doc]**: A new documentation
- **[translation]**: A new translation

## Coding Guidelines

Here are the coding guidelines we use for ExpressoTS: [Typescript Coding Guidelines](https://github.com/rsaz/TypescriptCodingGuidelines/blob/main/TypeScriptCodingGuidelines.md)

## Submitting your Pull Request
### [ Doc ] Submitting your Pull Request

### Description
### [ Doc ] Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

### Type of change
### [ Doc ] Type of change

Please delete options that are not relevant.

Expand All @@ -62,6 +48,28 @@ Please delete options that are not relevant.
- [ ] New Feature
- [ ] Translation:: New language

## Report an Issue or a Bug

If you find a bug in the source code, you can help us by submitting an issue in the **[Issue reporting channel](https://github.com/expressots/expressots-cli/issues)**. Event better, you can submit a **[Pull Request](https://github.com/expressots/expressots-cli/pulls)** with a fix.

## Request a feature

You can request a new feature by submitting an issue in the **[Issue reporting channel](https://github.com/expressots/expressots-cli/issues)**.

If you would like to implement the new feature, please submit an issue describing your proposal first. Thi will allow us to provide feedback, ensure that the feature is aligned with the project goals and that you are not duplicating work.

## Coding Guidelines

Here are the coding guidelines we use for ExpressoTS: [Typescript Coding Guidelines](https://github.com/rsaz/TypescriptCodingGuidelines/blob/main/TypeScriptCodingGuidelines.md)

## Submitting your Pull Request

### Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

### How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration if applicable.
Expand Down

0 comments on commit 2e4ae5a

Please sign in to comment.