Skip to content
This repository has been archived by the owner on Sep 7, 2024. It is now read-only.

Latest commit

 

History

History
96 lines (63 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

96 lines (63 loc) · 2.96 KB
Raw

Contributing Guidelines

Thank you for considering contributing to this project! We appreciate your time and effort. Please follow these guidelines to contribute effectively.

Table of Contents

Introduction

Welcome to my guide! This document provides guidelines and information on how to contribute to the guide.

Getting Started

To get started with contributing, follow these steps:

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Familiarize yourself with the project's structure and existing steps.
  4. Read the whole guide to understand the guides purpose and goals.

How to Contribute

  1. Before starting any work, create a new branch from the main branch.
  2. Ensure that your code follows the guides style and structure.
  3. Make commits with clear and descriptive commit messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the main repository.
  6. Engage in any feedback or discussion related to your pull request.
  7. Once approved, your changes will be merged into the main branch.

General Guidelines

Please adhere to the following code guidelines when contributing:

  • Follow the guides style and structure.
  • Use trusted sources, add these sources to the database.

Issues

If you encounter an issue, please follow these steps to report it:

  1. Check if the issue has already been reported.
  2. If the issue hasn't been reported, create a new issue with a clear and descriptive title.
  3. Provide detailed steps as to why this is an issue and any relevant information.
  4. Attach any necessary screenshots or additional files.

Feature Requests

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

  1. Search through the issues to ensure that the feature hasn't already been suggested.
  2. If the feature hasn't been suggested, create a new issue with a clear and descriptive title.
  3. Provide a detailed description of the proposed feature and why it would be valuable.

Pull Requests

We welcome contributions through pull requests. Please follow these guidelines:

  1. Fork the repository and create a new branch for your changes.
  2. Make your modifications or add new features.
  3. Update the database if necessary.
  4. Commit your changes with a descriptive commit message.
  5. Push your branch to your forked repository.
  6. Submit a pull request to the main repository.
  7. Engage in any feedback or discussion related to your pull request.
  8. Once approved, your changes will be merged into the main branch.

License

By contributing to this guide, you agree that your contributions will be licensed under the guides license.