Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update guidelines for making issues and commits #553

Merged
merged 13 commits into from
May 19, 2023
Prev Previous commit
Next Next commit
chore: added issues & commites guidelines
  • Loading branch information
rupali-codes committed May 18, 2023
commit bbae80077e950adc72f60f815e202cbf92d74233
25 changes: 23 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Thank you for taking the time to contribute to our project. Please take a moment

#### 🌟Follow these steps to get your Links added into the Hub

* A newly created category and subcategory should be added to the data file
* A newly created category and subcategory should be added to the [data.ts](https://github.com/rupali-codes/LinksHub/blob/main/database/data.ts) & [index.ts](https://github.com/rupali-codes/LinksHub/blob/main/database/index.ts) files
* Each category has it's own folder with it's name
rupali-codes marked this conversation as resolved.
Show resolved Hide resolved
* Every subcategory should be placed in it respective category folder
* Every subcategory should be placed in it's respective category folder
rupali-codes marked this conversation as resolved.
Show resolved Hide resolved

> i.e images should be inside Frontend folder

Expand Down Expand Up @@ -73,6 +73,27 @@ The subcategory object should follow this pattern
> - Your entries should follow the above structure.

---
## Issues
* Select an issue template from [issues](https://github.com/EddieHubCommunity/LinkFree/issues/new/choose) tab. Otherwise choose **Other** if it doesn't match what you're looking for.
* When creating an issue make sure you fill up all the fields properly.
* Make sure that you are NOT raising a **duplicate issue**.
* If you want to work on the issue, please tick *I am willing to work on this issue* checkmark. Then you can start working on the issue.
* If you aren't the owner of the issue, please comment that you're willing to work on the issue and wait for maintainers to assign you the issue. Also don't work on the issue if you're NOT assigned.
* Work on only ONE issue at a time
rupali-codes marked this conversation as resolved.
Show resolved Hide resolved

**Closing the issue**

* While closing the issue, please leave a reasonable comment that Why you're closing the issue
* If the Pull Request associated with issue get's mereged and the issue still remains open, it's you're responsibility to close the issue
rupali-codes marked this conversation as resolved.
Show resolved Hide resolved

## Commits
* Please keep your commit message short and clear.
rupali-codes marked this conversation as resolved.
Show resolved Hide resolved
* Use `type: subject` format for writing your commit messages. `type` could be one the followings:
* `feat`: use this if you're adding any new feature
* `fix`: use this if you're fixing anything in the codebase
* `chore`: use this when you're adding new links/resources
(ex. chore: added *resource_name* in *subcategory* *category* )

rupali-codes marked this conversation as resolved.
Show resolved Hide resolved
## Making Pull Requests

1. When you submit a pull request, several tests are automatically run
Expand Down