Thank you for your interest in contributing to Wander !
We appreciate your efforts in helping improve the app, whether through code, ideas, or documentation. Please follow these guidelines to ensure smooth collaboration.
-
Fork the repository to your own GitHub account.
-
Clone your fork to your local machine:
git clone https://github.com/your-username/wander.git
-
Create a new branch for your feature or fix:
git checkout -b feature-name
-
Make your changes in your local repository.
-
Commit your changes with a clear message:
git commit -m "Add [feature/bug] description" -
Push your changes to your fork:
git push origin feature-name
-
Open a pull request from your fork to the main repository.
We will review your pull request as soon as possible. Please be patient if it takes a little time.
If you find any issues with the app, please submit an issue with the following information:
- Steps to reproduce the bug
- A detailed description of the problem
- Your environment (OS, browser, etc.)
- Screenshots or error logs, if applicable
This helps us quickly understand and resolve the issue.
We welcome new ideas for features or improvements! To suggest a feature, please:
- Open an issue with a detailed description of the feature.
- Explain why this feature would improve the app.
- If possible, suggest how it could be implemented.
Our team will review and discuss the suggestion, and if approved, it may be assigned for development.
Tip
Before making a new branch, Make sure to get the latest update from the main branch.
git fetch origin
git pull
Then create a new branch based on the issue.
Make sure that you are working on a single problem.
If you have other concerns, feel free to go to discussions on the GitHub project and make a new discussion.
- Keep it Small: Aim to create small, focused pull requests that fulfill a single purpose. Smaller PRs are easier and faster to review and merge, and they reduce the risk of introducing bugs1.
- Self-Review: Before submitting, review, build, and test your own pull request. This helps catch errors or typos that you might have missed1.
-
Clear Titles and Descriptions: Write clear titles and descriptions for your pull requests so that reviewers can quickly understand what the PR does. Include the purpose of the PR, an overview of what changed, and links to any additional context such as tracking issues or previous conversations1.
-
Guidance for Reviewers: If your PR consists of changes to multiple files, provide guidance to reviewers about the order in which to review the files. Recommend where to start and how to proceed with the review1.
- Standardize Information: Use pull request templates to standardize the information included when someone creates a PR in your repository. This can include a list of tasks to complete before merging1.
- Reference Issues: Include an issue reference in your PR body to automatically close the issue when the PR is merged. This helps keep your project organized1.
-
Feedback Requests: Share the type of feedback you need. For example, specify if you need a quick look or a deeper critique1.
Tip
For major changes or UI changes, please include a screenshot on how it looks like on your end. It'll make the review faster for easier and faster pull merges.
Your contributions make Wander better for everyone. We appreciate all kinds of contributions, no matter how small. Let's build something amazing together! 🚀