Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

82 lines (53 loc) · 3.26 KB

Learn Vim and NeoVim Tutorial Repository Contribution Guidelines

Thank you for considering contributing to the Learn Vim and NeoVim Tutorial Repository! We appreciate your help in making this resource even better.

Before you start, please take a moment to read through the following guidelines to ensure a smooth and effective collaboration.

Table of Contents

Introduction

This repository contains a tutorial for learning Vim and NeoVim. We aim to provide high-quality, beginner-friendly content to help individuals master these powerful text editors.

Getting Started

  • Fork this repository.
  • Clone your forked repository to your local machine.
  • Please refer to this guide for more information on how to contribute to the repository.

How to Contribute

Bug Reports

If you find a bug or issue within the tutorial, please help us by submitting a detailed bug report. Include the following information:

  • Title: A short, descriptive title for the bug report.
  • Description: Detailed explanation of the bug including steps to reproduce it.
  • Expected Behavior: What you expected to happen.
  • Actual Behavior: What actually happened.
  • Environment: Your operating system, Vim/NeoVim version, and any other relevant details.

Feature Requests

If you have an idea for a new feature or improvement, please submit a feature request. Include the following information:

  • Title: A clear title describing the feature or improvement.
  • Description: Detailed explanation of the proposed change.
  • Rationale: Why this feature or improvement would be valuable.

Code Contributions

We welcome contributions in the form of code improvements, bug fixes, or new features. To contribute code:

  1. Create a new branch with a descriptive name.
  2. Make your changes, ensuring adherence to the style guide.
  3. Test your changes thoroughly.
  4. Create a pull request with a clear title and description of your changes, or just follow the provided pull request template.

Documentation

If you find areas in the tutorial that lack clarity or need additional explanations, please consider contributing to the documentation. Provide clear and concise explanations to improve the learning experience.

Style Guide

Please follow these guidelines when contributing code:

  • Use meaningful variable and function names.
  • Write clear, concise comments to explain complex logic.
  • Adhere to the existing code formatting conventions.
  • Write descriptive commit messages.

Code of Conduct

Please note that this project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to [email protected].

License

This project is licensed under the MIT License.

Thank you for contributing to the Learn Vim and NeoVim Tutorial Repository. Your efforts are greatly appreciated!