Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 2.68 KB

Contributing to GitKraken-Compendium

Thank you for considering contributing to GitKraken-Compendium! 🎉

The goal of this repository is to provide an extensive resource for GitKraken users and enthusiasts. We value your contributions and welcome any improvements, bug fixes, or new content that can enhance the overall experience of our users.

Table of Contents

Getting Started

Before contributing to GitKraken-Compendium, please ensure you have the following:

  • An active GitHub account.
  • Familiarity with Markdown syntax for writing content.
  • Basic knowledge of Git and how to create pull requests.

Contributing Guidelines

  1. Fork the GitKraken-Compendium repository to your GitHub account.

  2. Clone your forked repository to your local machine: https://github.com/AnthonyByansi/GitKraken-Compendium.git

  3. Create a new branch for your contributions: git checkout -b feature/your-feature-name

  4. Make your changes and improvements, adhering to the repository's file structure and formatting guidelines.

  5. Commit your changes with a clear and descriptive commit message: git commit -m "Add feature: your feature description"

  6. Push your changes to your GitHub repository: git push origin feature/your-feature-name

  8. Create a pull request (PR) from your branch to the main branch of the original repository.

  9. Your PR will be reviewed by maintainers, and if everything looks good, it will be merged.

Code of Conduct

Please adhere to the Code of Conduct when contributing to this project. We promote a respectful and inclusive community for everyone.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please check the existing issues and open a new issue if necessary. Provide as much detail as possible to help us understand and address the problem effectively.

Making Contributions

We welcome the following types of contributions:

  • Creating or updating user guides, tutorials, and documentation.
  • Fixing grammatical errors, typos, or broken links.
  • Implementing improvements to the source code or testing suites.

Static Badge

graph LR;
 A[User] --> B(GitKraken-Compendium);
 B --> C{Review};
 C --> B;
 C --> D[Approved];
 C --> E[Changes requested];
 D --> B;
 E --> B;
Loading