Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 2.09 KB

Contributing to DonkeyDoc

Thank you for considering contributing to DonkeyDoc! We welcome contributions from everyone, whether you're fixing bugs, adding features, improving documentation, or promoting the project.

How to Contribute

1. Fork the Repository

Start by forking the repository on GitHub. This will create a personal copy of the project that you can modify.

2. Clone Your Fork

Clone your forked repository to your local machine:

git clone https://github.com/YOUR_USERNAME/DonkeyDoc.git
cd DonkeyDoc

  1. Create a New Branch Create a new branch for your feature or bug fix: git checkout -b my-feature

  2. Make Changes Make the necessary changes in your local repository. Be sure to follow the coding style used in the project.

  3. Test Your Changes Run tests to ensure your changes don’t break any existing functionality. If the project doesn’t have tests set up yet, consider adding them!

  4. Commit Your Changes Commit your changes with a clear message describing what you’ve done:

git add . git commit -m "Add a descriptive message about your changes"

  1. Push Your Changes Push your changes to your forked repository:

git push origin my-feature

  1. Create a Pull Request Go to the original repository on GitHub and click on the “New Pull Request” button. Select your branch and describe the changes you made.

Guidelines

  • Create an Issue: Before implementing a feature or fix, create an issue describing what you want to include.
  • No Third-Party Code: Avoid using third-party code or dependencies. Ensure your contribution is original.
  • LLM Help: You may consult language models for ideas, but do not include code generated by LLMs directly.

Types of Contributions

Code Contributions: Bug fixes, new features, or improvements to the existing codebase. Documentation: Improve the README, create guides, or help with other documentation efforts. Promotion: Share DonkeyDoc on social media, write blogs, or create tutorials.

Code of Conduct

Please adhere to the Code of Conduct in all interactions. We strive to create a welcoming environment for everyone.