Skip to content

Contribution Guidelines and Code of Conduct

Deeptanu2005 edited this page Jun 1, 2024 · 3 revisions

Contribution Guidelines and Code of Conduct

Contribution Guidelines

Contributions to Pinned Links Manager are welcome! If you have any ideas for improvements, new features, or bug fixes, feel free to open an issue or submit a pull request.

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. Navigate to the project directory:

    cd Pinned-Links-Manager
    
  4. Create a Branch: Create a new branch for your feature or bug fix.

    git checkout -b feature/your-feature-name
  5. Make Your Changes: Make your changes to the code.

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

    git add .
    git commit -m "Add feature: Your feature description"
  7. Push to Your Fork: Push your changes to your forked repository.

    git push origin feature/your-feature-name
  8. 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 of Conduct

Pinned Links Manager follows the Contributor Covenant Code of Conduct to ensure a welcoming and inclusive community. Please review the Code of Conduct for details on expected behavior and enforcement guidelines.