Thanks for reaching the project and wanting to improve the extension! This file has few guidelines that will help you along the way.
Please, make sure you read the Code of Conduct file before contributing! It is short, it will not take you much time 😉!
The first thing would be to create an issue, which would notify the contributors. Furthermore, it gives more visibility to the problem or feature and may attract other people on helping. You can propose a solution to the issue by creating a pull request. If you do not feel like contributing, no worries, a maintainer will come to help!
When developing, make sure to following the below steps:
- Fork the repository.
- Clone the repository to your local machine, adding the original repo as an upstream remote:
also use https # git clone
https://github.com/<your-name>/dartBarrelFileGenereator.git cd
dart-barrel-file-generator git remote add upstream
https://github.com/mikededo/dart-barrel-file-generator.git ```
3. Synchronize the branch:
```sh git checkout main git pull upstream main ```
4. Install all the dependencies:
```sh yarn ```
5. Create the new branch:
```sh git checkout -b branch-with-sense ```
6. Save changes and push to your fork:
```sh git push -u origin HEAD ```
7. Create a pull request with your changes.
#### Commits
Make sure to commit using semantic commits. Also, its recommended to:
- Check for the linting and formatting, using ESLint (see the [config file](.eslintrc.json)).
- Add a changeset to your changes, with `bun changeset`.
#### Merging a PR
After your code has been reviewed and approved, one of the administrators will
squash the changes to the base branch.
## License
By contributing your code to this repository, you agree to license your
contribution under the [MIT License](LICENSE).