Skip to content

Latest commit

 

History

History
92 lines (55 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

92 lines (55 loc) · 2.64 KB

How to contributing Daemawiki?

We appreciate your interest in contributing to Daemawiki! Whether you're fixing a bug, adding a feature, or improving documentation, your efforts make a huge difference. Follow this guide to get started:

Step 1: Fork and Clone the Repository

  1. Fork the repository to your GitHub account by clicking the Fork button on the top-right corner of the project page.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/<your-username>/Claude.git
cd Claude

Step 2: Create a Branch

Create a new branch for your changes. Use a meaningful name that describes your contribution:

git checkout -b feature/your-feature-name

Step 3: Make Your Changes

  • For code changes, ensure they follow the project's coding standards and include appropriate tests.
  • For documentation updates, make sure your additions are clear and concise.
  • Test your changes thoroughly to ensure they work as expected.

Step 4: Commit Your Changes

Write clear, descriptive commit messages following the Conventional Commits specification:

git commit -m "feat(core): add support for collaborative editing"

Step 5: Push Your Branch

Push your branch to your forked repository:

git push origin feature/your-feature-name

Step 6: Create a Pull Request

  1. Navigate to the original Daemawiki repository on GitHub.
  2. Click on Pull Requests and then New Pull Request.
  3. Choose your forked branch as the source and submit the pull request.

Include the following in your pull request description:

  • A brief summary of the changes.
  • Any relevant issue numbers (e.g., closes #1234).
  • Steps for testing your changes, if applicable.

Step 7: Participate in the Review

Your pull request will be reviewed by the maintainers. Be ready to:

  • Address feedback or make necessary changes.
  • Discuss your approach if required.

Step 8: Celebrate! 🎉

Once your pull request is merged, congratulations on contributing to Daemawiki! You're now part of the team improving this platform.

Additional Notes

  • If you're unsure where to start, check out issues labeled good first issue or help wanted.
  • Follow the Code of Conduct to ensure a welcoming and respectful environment.

For any questions, feel free to create an issue or contact us through the discussion forum.