Skip to content

Contributing

Jump to bottom
Puneet Kumar Mishra edited this page Oct 15, 2026 · 1 revision

🤝 Contributing to CrowdWide

Thank you for your interest in contributing to CrowdWide!

Contributions can include bug fixes, new features, documentation improvements, testing, and suggestions.

🚀 Getting Started

Before making changes:

  1. Read the Project Overview.
  2. Follow the Getting Started guide.
  3. Review the existing code and documentation.
  4. Check the repository's open issues for existing discussions.

🔀 Contribution Workflow

1. Fork the Repository

Create your own fork of the CrowdWide repository.

2. Clone Your Fork

Clone your fork to your local machine:

git clone https://github.com/YOUR-USERNAME/Crowdwide.git
cd Crowdwide

Replace YOUR-USERNAME with your GitHub username.

3. Create a Branch

Create a separate branch for your change:

git checkout -b feature/your-change

Use a descriptive branch name that reflects your contribution.

4. Make Your Changes

  • Keep changes focused and easy to review.
  • Follow the existing code style.
  • Avoid unrelated modifications.
  • Update documentation when behavior changes.
  • Never include passwords, API keys, or other secrets.

5. Test Your Changes

Run the relevant tests before submitting your contribution.

Consult the repository's package.json and existing documentation for the available test commands.

6. Commit Your Changes

Write a clear commit message:

git add .
git commit -m "Describe your change"

Only stage files you intend to include in the contribution.

7. Push Your Branch

git push origin feature/your-change

8. Open a Pull Request

Open your fork on GitHub and create a pull request targeting the original CrowdWide repository.

Explain:

  • What you changed.
  • Why the change is needed.
  • How you tested it.
  • Any relevant screenshots or additional context.

🐛 Reporting Bugs

When reporting a bug, include:

  • A clear description of the problem.
  • Steps to reproduce it.
  • Expected behavior.
  • Actual behavior.
  • Relevant error messages or screenshots.

Remove passwords, tokens, and personal information before sharing logs.

Report an issue

💡 Suggesting Features

Feature suggestions should explain the problem being solved, the proposed improvement, and how it could benefit CrowdWide users.

Check existing issues before opening a new discussion.

📖 Documentation Contributions

Documentation improvements are welcome too!

You can help by fixing unclear instructions, correcting errors, improving examples, and keeping the Wiki synchronized with the codebase.

✅ Before Submitting

  • My changes have a clear purpose.
  • I have tested the relevant functionality.
  • I have updated the documentation where needed.
  • I have not committed secrets or credentials.
  • My pull request explains the changes.

📜 Code of Conduct

Be respectful, constructive, and welcoming when interacting with other contributors.

Follow any code of conduct or contribution rules provided in the repository.

Thank you for helping make CrowdWide better! 🌐

Clone this wiki locally