Skip to content

Contributing

Thank you for your interest in contributing to Resourge! Your help is essential in making this project better, more reliable, and more useful for everyone.

  • Report Bugs: If you discover any bugs or unexpected behavior, please provide a detailed description so the team can reproduce and fix the issue quickly.
  • Suggest New Features: Have ideas to improve Resourge? Share your suggestions clearly so we can consider adding them in future releases.
  • Submit Pull Requests: Contributions like bug fixes, improvements, or new features are always welcome. Feel free to fork the repository, create a branch for your changes, and submit a pull request for review.
  • Improve Documentation: Good documentation helps everyone! If you spot errors, outdated info, or missing examples, updating the docs is a great way to contribute.
  1. Fork the repository to your own GitHub account.

  2. Clone your fork locally:

    Terminal window
    git clone https://github.com/your-username/resourge.git
  3. Navigate to the project folder and install dependencies:

    Terminal window
    npm install
  4. Create a new branch for your changes.

  5. Make your changes in the code or documentation.

  6. Run tests to ensure nothing is broken:

    Terminal window
    npm test
  7. Commit your changes with clear and descriptive messages.

  8. Push your branch to your forked repository.

  9. Open a pull request describing your changes and why they improve the project.

Please be respectful, collaborative, and constructive when engaging with other contributors. Follow the community’s Code of Conduct to maintain a welcoming and inclusive environment.


Thank you again for contributing! Your efforts help Resourge grow and serve developers around the world better every day.