Home

Awesome

<h1 align="center">ngx-toastr-message<h2> <p align="center">A lightweight, customizable Angular library for displaying toast notifications.</p>

Contributing to ngx-toastr-message

Thank you for your interest in contributing to ngx-toastr-message! We appreciate your help in improving this project. Please follow the guidelines below to make your contributions smooth and effective.

Table of Contents

Getting Started

  1. Fork the Repository: Click the "Fork" button on the top right of this page to create a copy of the repository in your GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/One-Zero-Code/ngx-toastr-message.git
cd ngx-toastr-message

  3. Install Dependencies: Install the necessary dependencies for development

    npm install

  4. Build Libary:

    ng build ngx-toastr-message

  5. Install Libary

    npm install ./dist/ngx-toastr-message

How to Contribute

We welcome contributions in various forms, including:

  1. Bug Fixes: Report and fix bugs.
  2. New Features: Suggest and implement new features.
  3. Documentation: Improve documentation and examples.
  4. Code Review: Review pull requests from other contributors.

Development Guidelines

  1. Follow the existing code style.
  2. Write unit tests for new features and bug fixes. Ensure that all tests pass before submitting your pull request.
  3. Document your code where necessary to maintain clarity and usability.

Submitting Changes

  1. Create a New Branch: Create a new branch for your changes. 
    git checkout -b your-feature-name
  2. Make Your Changes: Implement your changes and test them thoroughly.
  3. Commit Your Changes: Commit your changes with a clear and concise commit message. 
    git commit -m "Add your commit message here"
  4. Push to Your Fork: Push your changes to your forked repository. 
    git push origin your-feature-name
  5. Open a Pull Request: Navigate to the original repository and open a pull request. Provide a clear description of your changes and any relevant context.

License

By contributing to [Your Angular Library Name], you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions!