diff-ymd-package/CONTRIBUTING.md

A javascript library for calculating the difference between two dates in formatted ways like (aY bM cD)(aYears bMonths cDays) or customized desired formats like aY-bM-cD or aYears-bMonths-cDays or kDays or mWeeks or nMonths etc.

## Contributing Guidelines for diff-ymd-package

Thank you for considering contributing to diff-ymd-package! 🚀

### Table of Contents

1. [Code of Conduct](#code-of-conduct)
2. [How to Contribute](#how-to-contribute)
    - [Reporting Bugs](#reporting-bugs)
    - [Feature Requests](#feature-requests)
    - [Pull Requests](#pull-requests)
3. [Development Setup](#development-setup)
4. [Coding Guidelines](#coding-guidelines)
5. [Testing](#testing)
6. [Versioning](#versioning)
7. [Community](#community)

#### Code of Conduct

Please read and adhere to our Code of Conduct [available here](CODE_OF_CONDUCT.md).

#### How to Contribute

##### Reporting Bugs

If you encounter a bug, please open an issue with the following details:
- A clear and concise title.
- A detailed description of the bug, including steps to reproduce.
- The expected behavior and the actual behavior.

##### Feature Requests

If you have an idea for a new feature, feel free to open an issue with the following details:
- A clear and concise title.
- A detailed description of the proposed feature.

##### Pull Requests

1. Fork the repository and create a new branch(or make changes on same branch).
2. Make your changes and ensure the code follows our coding guidelines.
3. Write tests to cover your changes.
4. Ensure the existing tests pass.
5. Open a pull request with a clear title and description of your changes.

#### Development Setup

To set up your development environment, follow these steps:
1. Clone the repository.
2. Install dependencies using `npm install`.
3. Make your changes.

##### Coding Guidelines

Please follow the coding guidelines outlined in the documentation [available here](./README.md#best-practices).

##### Testing

Run tests using the following command:
```bash
npm test

```

##### Versioning

Follow Semantic Versioning (SemVer) when making version changes.


##### Community

Join our discussions in the [GitHub Discussions](https://github.com/farhan7reza7/diff-ymd-package/discussions) to engage with the community and get help.

Happy coding! 🎉