Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

51 lines (35 loc) · 2.84 KB
Raw

Toaster-UI Contribution Guidelines

Thank you for considering contributing to Toaster-UI! We welcome your contributions to make Toaster-UI better for everyone. Whether you want to report a bug, suggest a feature, or submit a pull request, please follow the guidelines outlined in this document.

Bug Reports and Feature Requests

If you encounter a bug or have a feature request, please check the existing issues on the Toaster-UI GitHub repository to see if it has already been reported. If not, feel free to open a new issue with the necessary details, including a clear description and any relevant code examples or error messages.

Pull Requests

We appreciate your efforts to improve Toaster-UI through pull requests. To ensure smooth collaboration, please follow these guidelines when submitting a pull request:

  1. Fork the repository and create a new branch for your changes.
  2. Ensure that your code adheres to the project's coding style and conventions.
  3. Include clear and concise commit messages that describe the purpose of your changes.
  4. Provide tests for any new functionality or bug fixes to maintain code quality.
  5. Make sure all existing tests pass successfully.
  6. Include documentation updates if necessary.
  7. Submit your pull request, clearly explaining the changes you've made and the problem it solves.

Development Setup

To get started with Toaster-UI development, follow these steps:

  1. Fork the repository and clone it to your local machine.
  2. Install the required dependencies by running npm install.
  3. Make your changes and test them thoroughly then run npm run build.
  4. Run the existing tests to ensure they pass using npm test.
  5. If you've added new functionality, write corresponding tests to cover it.
  6. Update the documentation if necessary.
  7. Commit your changes and push them to your forked repository.
  8. make sure you update the version in package.json if necessary
  9. Open a pull request on the main repository and provide a detailed description of your changes.

Code Style and Conventions

Toaster-UI follows a specific code style and set of conventions. Please adhere to the following guidelines:

  • Use meaningful variable and function names to improve code readability.
  • Follow the existing indentation style (e.g., 2 spaces) for consistent formatting.
  • Use comments to explain complex code sections or provide context where necessary.
  • Avoid code duplication and promote reusability.
  • Write clear and concise documentation for any new functionality.

License

By contributing to Toaster-UI, you agree that your contributions will be licensed under the MIT License.

If you have any questions or need further assistance, please don't hesitate to reach out to us. We appreciate your support and look forward to your contributions!

Happy coding!