Skip to content

Commit

Permalink
docs: add contributing guidelines and fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
Anmol-Baranwal committed Nov 11, 2023
1 parent 839664e commit a3860d6
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ body:
options:
- label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues?q=is%3Aissue+)"
required: true
- label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/CONTRIBUTING.md)"
- label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/Contributing.md)"
required: true
- label: "I am willing to work on this issue (optional)"
required: false
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ body:
options:
- label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues?q=is%3Aissue+)"
required: true
- label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/CONTRIBUTING.md)"
- label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/Contributing.md)"
required: true
- label: "I am willing to work on this issue (optional)"
required: false
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ body:
options:
- label: "I have checked the existing [issues](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues?q=is%3Aissue+)"
required: true
- label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/CONTRIBUTING.md)"
- label: "I have read the [Contributing Guidelines](https://github.com/Anmol-Baranwal/handle-multiple-issues/blob/main/Contributing.md)"
required: true
- label: "I am willing to work on this issue (optional)"
required: false
46 changes: 45 additions & 1 deletion Contributing.md
Original file line number Diff line number Diff line change
@@ -1 +1,45 @@
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
# Contributing Guidelines

[fork]: https://github.com/Anmol-Baranwal/handle-multiple-issues/fork
[pr]: https://github.com/Anmol-Baranwal/handle-multiple-issues/compare
[code-of-conduct]: CODE_OF_CONDUCT.md

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Thank you for taking the time to contribute to our project. Please take a moment to read the following guidelines before contributing:

> ⚠️IMPORTANT **Note**
>
> **Pull Requests _having no issue associated_ with them _will not be accepted_. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.**
## Prerequisites ⚠️

- Open Source Etiquette: If you've never contributed to an open source project before, have a read of [Basic etiquette](https://developer.mozilla.org/en-US/docs/MDN/Community/Open_source_etiquette) for open source projects.

- Basic familiarity with Git and GitHub: If you are also new to these tools, visit [GitHub for complete beginners](https://developer.mozilla.org/en-US/docs/MDN/Contribute/GitHub_beginners) for a comprehensive introduction to them.

## Found a bug?

- **Ensure the bug was not already reported** by searching the existing [Issues](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues?q=is%3Aissue+).
- If you're unable to find an open issue addressing the problem, open a new one using this [bug template](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues/new). Be sure to include a **title and clear description**, and as much relevant information as possible.

## What should I know before submitting a pull request or issue

This workflow is written in [TypeScript](https://www.typescriptlang.org/), a typed variant of JavaScript, and we use [Prettier](https://prettier.io/) to get a consistent code style.

Because of how GitHub Actions are run, the source code of this project is transpiled from TypeScript into JavaScript. The transpiled code (found in `lib/`) is subsequently compiled using [NCC](https://github.com/vercel/ncc/blob/master/readme.md) (found in `dist/`) to avoid having to include the `node_modules/` directory in the repository.

## Submitting a pull request

> ℹ️ Keep your change as focused as possible.
1. [Fork][fork] and clone the repository
1. Configure and install the dependencies: `npm install`
1. Create a new branch: `git checkout -b my-branch-name`
1. Make your change, test it thoroughly. You can write tests to see if all the tests are passing.
1. Update `dist/index.js` using `npm run build`. This creates a single javascript file that is used as an entrypoint for the action
1. Push to your fork and [submit a pull request][pr]

## Remarks ✅

- If something is missing here, or you feel something is not well described, please [raise an issue](https://github.com/rupali-codes/LinksHub/issues) with relevant template.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ with:

### How to Suggest Features

All changes are welcome. Please read our [contributing guidelines](CONTRIBUTING.md)
All changes are welcome. Please read our [contributing guidelines](Contributing.md)

Feel free to suggest any features or report bugs using these [issue templates](https://github.com/Anmol-Baranwal/handle-multiple-issues/issues/new/choose).

Expand Down

0 comments on commit a3860d6

Please sign in to comment.