Skip to content

Latest commit

 

History

History
69 lines (40 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

69 lines (40 loc) · 2.76 KB
Raw

Contributing to Emacs Guide

Thank you for considering contributing to the Emacs Guide! We appreciate your interest in helping us create a comprehensive and helpful tutorial on using Emacs. By contributing, you can help make this guide even more valuable to the Emacs community.

Please take a moment to review this guide to understand how you can contribute effectively.

Contributing to Emacs Guide

Thank you for considering contributing to the Emacs Guide! We appreciate your interest in helping us create a comprehensive and helpful tutorial on using Emacs. By contributing, you can help make this guide even more valuable to the Emacs community.

Please take a moment to review this guide to understand how you can contribute effectively.

Getting Started

  1. Fork the Repository: Click the "Fork" button at the top-right corner of this repository to create your own copy.

  2. Clone the Repository: Clone your forked repository to your local machine:

    git clone https://github.com/your-username/emacs-guide.git

  3. Create a New Branch: Create a new branch for your contribution:

    git checkout -b feature/your-feature-name

  4. Make Changes: Make your changes or additions to the guide. Ensure your code follows the project's coding guidelines.

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

    git commit -m "Add feature/fix: Brief description of your changes"

  6. Push Changes: Push your changes to your forked repository:

    git push origin feature/your-feature-name

  7. Create a Pull Request: Go to the original repository on GitHub and create a Pull Request (PR) from your forked branch to the main branch of the original repository.

Code Style and Guidelines

Please follow these guidelines when contributing:

  • Use clear and concise language in your explanations and examples.
  • Follow the existing style and formatting of the guide.
  • Keep paragraphs and sentences concise for better readability.
  • Use code blocks for presenting code snippets.
  • When adding code examples, ensure they are correct and functional.

Review Process

All contributions will be reviewed by project maintainers. They may provide feedback and suggest changes to improve the quality and accuracy of the content.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. Be sure to provide a detailed description of the problem or the proposed enhancement.

Licensing

By contributing to the Emacs Guide, you agree that your contributions will be licensed under the MIT License.

Thank you for your contributions and for helping make the Emacs Guide a valuable resource for the Emacs community!