Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ChunhThanhDe authored Nov 27, 2024
1 parent 7c4a3cd commit d9c3082
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,57 @@
# Contributing to Flutter Journey 🚀
# Contributing to Flutter Journey

Hi there! We're thrilled that you're interested in contributing to **Flutter Journey**. Your help is essential to improving the project and building a stronger Flutter community. Below are the guidelines for how you can contribute effectively.
Thank you for your interest in contributing to **Flutter Journey**! Your contributions are crucial to improving the project and building a stronger Flutter community. Below are the detailed guidelines for how you can contribute effectively.

## How You Can Contribute 💡
## How You Can Contribute

### 1. Report Bugs 🐛
If you find any bugs or unexpected behavior in the project, feel free to report them. Please include:
### 1. Report Bugs
If you find any bugs or unexpected behavior in the project, feel free to report them. Please provide the following details:

- Steps to reproduce the issue.
- What you expected to happen.
- Any relevant screenshots or logs.

You can submit bug reports through GitHub issues.

### 2. Suggest Fixes 🔧
If you have a solution or suggestion for a bug or an issue, feel free to submit it as a pull request.
### 2. Suggest Fixes
If you have a solution or suggestion for a bug or issue, you can submit it as a pull request.

Follow these steps for submitting a fix:

Follow the guidelines below for submitting a fix:
1. **Fork and clone the repository**: This gives you your own copy to work on.
1. **Fork and clone the repository**: This creates your own copy to work on.
2. **Create a new branch**: `git checkout -b fix/your-fix-name`
3. **Make your changes**: Focus on resolving the issue and include necessary tests.
3. **Please make your changes**: Focus on fixing the issue and include any necessary tests.
4. **Run tests**: Ensure all tests pass before submitting. You can do this with `flutter test` or any other testing script the project uses.
5. **Submit a pull request**: Once your changes are ready, push to your fork and create a pull request.

### 3. Request Features
Do you have an idea that can make **Flutter Journey** even better? You can request new features by opening a GitHub issue, clearly describing:
### 3. Request Features
Do you have an idea to make **Flutter Journey** even better? You can request new features by opening a GitHub issue and clearly describing:

- The problem your feature solves.
- How it would work in practice.
- Any potential alternatives or existing solutions.

We encourage discussions around new features to ensure they're aligned with the project's goals.
We encourage discussions around new features to ensure they align with the projects goals.

## Submitting a Pull Request
## Submitting a Pull Request

1. **Fork and clone**: Start by forking the repo and cloning it to your machine.
2. **Install dependencies**: Run `flutter pub get` to install necessary dependencies.
2. **Install dependencies**: Run `flutter pub get` to install the necessary dependencies.
3. **Create a new branch**: Branches help keep your work organized: `git checkout -b feature/your-feature-name`.
4. **Make your changes**: Try to keep the changes as focused as possible.
4. **Make your changes**: Try to keep the changes focused on your task.
5. **Add tests**: Write appropriate tests to validate your changes.
6. **Ensure tests pass**: Run tests locally to make sure everything works.
7. **Commit your work**: Use a clear commit message (e.g., "Add new feature X").
8. **Push and create a pull request**: Push your branch and create a pull request from your forked repository.

## Guidelines for Successful Contributions 🎯
## Guidelines for Successful Contributions

- Follow **Flutter Journey’s** [Code of Conduct](CODE_OF_CONDUCT.md).
- Make sure your code is well-documented and follows the project's coding style.
- Keep your changes focused on the specific bug fix or feature you're addressing. If unrelated changes are needed, submit them in separate pull requests.
- Ensure your code is well-documented and follows the project's coding style.
- Keep your changes focused on the specific bug fix or feature you're working on. If other changes are needed, submit them in separate pull requests.
- Write tests for your contributions to ensure they work as expected.

## Get Involved 🎉
## Get Involved

Your contribution doesn’t have to be code! You can help by:

Expand All @@ -60,4 +61,4 @@ Your contribution doesn’t have to be code! You can help by:

---

Thank you for taking the time to contribute! Together, we can help everyone on their journey to becoming a **Flutter Master**!
Thank you for taking the time to contribute! Together, we can help everyone on their journey to becoming a **Flutter Master**!

0 comments on commit d9c3082

Please sign in to comment.