Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 4.87 KB

CONTRIBUTING.md

File metadata and controls

95 lines (67 loc) · 4.87 KB
Raw

Contributing Guide for Calendar Widgets

Welcome, and thank you for your interest in contributing to Calendar Widgets, an open source project developed by Ninembs Studio LLC. This guide outlines how you can contribute to this project, from reporting bugs and suggesting new features to making code changes yourself.

Table of Contents

  1. Code of Conduct
  2. Prerequisites
  3. Reporting Bugs
  4. Suggesting New Features
  5. Contributing Code
  6. Pull Request Process
  7. Additional Resources

1. Code of Conduct

Before contributing to this project, please read and follow our Code of Conduct. It outlines the expectations and behavior for all contributors and maintainers of Calendar Widgets.

2. Prerequisites

To get started with contributing, you will need to have the following installed on your local machine:

  • Git
  • Node.js (LTS or current)
  • pnpm (latest version)

You can install the latest version of pnpm by running:

npm install -g pnpm

Familiarize yourself with the project by reading the README.md and exploring the codebase. Make sure to follow the instructions in the README for setting up the project using pnpm.

3. Reporting bugs

If you come across a bug while using Calendar Widgets, please report it by following these steps:

  1. Check the Issues to see if the bug has already been reported. If it has, please add any additional relevant information in the comments.
  2. If the bug hasn't been reported, create a new issue and provide the following information:
  • A clear and concise title
  • A detailed description of the bug
  • Steps to reproduce the bug
  • The expected behavior
  • Screenshots or GIFs, if applicable
  • System information (e.g., OS, browser, and version)

4. Suggesting New Features

If you have an idea for a new feature or improvement, please follow these steps:

  1. Check the Issues to see if a similar suggestion has already been made. If it has, please join the discussion and provide your feedback.
  2. If your suggestion is new, create a new issue and provide the following information:
  • A clear and concise title
  • A detailed description of the proposed feature
  • Any relevant context or examples, such as use cases or design mockups
  • An explanation of how the feature will benefit Calendar Widgets users

5. Contributing Code

Ready to contribute code to Calendar Widgets? Follow these steps:

  1. Fork the repository and clone your fork to your local machine.
  2. Create a new branch for your feature or bugfix, following the naming convention: feature/your-feature-name or bugfix/your-bugfix-name.
  3. Write clean, well-documented code that adheres to the project's coding standards.
  4. Ensure that your code passes all tests by running npm test.
  5. Add or update any relevant documentation or comments to ensure that other contributors can understand your changes.
  6. Commit your changes with a descriptive commit message.
  7. Push your branch to your fork on GitHub.

6. Pull Request Process

Once your code changes are ready, follow these steps to create a pull request (PR):

  1. Go to the Calendar Widgets repository and click on the "Pull requests" tab.
  2. Click on "New pull request" and select your fork and branch from the "compare" dropdown menu.
  3. Provide a clear and concise title for your PR.
  4. Describe your changes in detail, including any issues your PR resolves or features it introduces.
  5. Add any relevant labels, such as "bug", "enhancement", or "documentation".
  6. Request a review from at least one of the project maintainers.
  7. Submit your PR.

Once your PR has been submitted, maintainers and other contributors will review your changes. They may request additional changes or provide feedback. Address any requested changes and maintain open communication with reviewers.

Please be patient, as PR reviews can take time. Once your PR is approved and all checks have passed, a project maintainer will merge your changes into the main branch.

7. Additional Resources

To help you get started and become more familiar with the project, you can check the following resources:

If you have any questions or need assistance, feel free to reach out to the community on the project's Discussion board.

Thank you once again for your interest in contributing to Calendar Widgets. We look forward to working with you to improve and expand this project!