Skip to content

Latest commit

 

History

History
72 lines (45 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

72 lines (45 loc) · 2.76 KB
Raw

Contributing to Pinned Links Manager

First off, thank you for considering contributing to Pinned Links Manager! Your help is greatly appreciated.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub with as much detail as possible. Include steps to reproduce the issue, the environment in which the bug occurs, and any other relevant information.

  1. Go to the Issues page.
  2. Check if the issue has already been reported.
  3. If it hasn’t, create a new issue with the following details:
    • A descriptive title
    • Detailed description of the issue
    • Steps to reproduce
    • Environment (OS, browser, etc.)
    • Screenshots, if applicable

Suggesting Features

We welcome new ideas! If you have a feature request, please open an issue with the following details:

  1. Go to the Issues page.
  2. Create a new issue with the following details:
    • A descriptive title
    • Detailed description of the feature
    • Explanation of why this feature would be useful
    • Any other relevant information

Contributing Code

To contribute code, follow these steps:

  1. Fork the Repository: Click the "Fork" button at the top of this repository 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/your-username/Pinned-Links-Manager.git

  3. Create a Branch: Create a new branch for your feature or bug fix.

    git checkout -b feature/your-feature-name

  4. Make Your Changes: Make your changes to the code.

  5. Commit Your Changes: Commit your changes with a clear and descriptive commit message.

    git add .
git commit -m "Add feature: Your feature description"

  6. Push to Your Fork: Push your changes to your forked repository.

    git push origin feature/your-feature-name

  7. Create a Pull Request: Go to the original repository and create a pull request from your fork and branch. Provide a clear and descriptive title and description for your pull request.

Code Style

  • Follow the existing code style in the project.
  • Ensure your code is properly commented.
  • Write clear, concise commit messages.

Running Tests

If the project includes tests, ensure that your changes do not break any existing tests and that any new code is covered by tests.

Community Guidelines

Please adhere to our Code of Conduct to maintain a welcoming and inclusive community.

Thank You!

Thank you for taking the time to contribute to Pinned Links Manager! Your help is invaluable to improving the project for everyone.