Skip to content

Commit

Permalink
Add contribution guide (#172)
Browse files Browse the repository at this point in the history
* add contribution guide

* move file to main
  • Loading branch information
cp-ishita-g authored Dec 20, 2024
1 parent 59a4eb1 commit 1bd2f9f
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing

Thank you so much for your interest in contributing! All types of contributions are encouraged and valued. The Project Team looks forward to your contributions.

## Filing Issues

When in doubt, file an issue. We'd rather close a few duplicate issues than let a problem go unnoticed. Similarly, if you support a particular feature request, please let us know by commenting on the issue or [subscribing](https://help.github.com/articles/subscribing-to-conversations/) to the issue.

If you are reporting a bug, please help speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project (or gist) that reproduces the problem.

## Contributing Code

We actively welcome your pull requests. You can find instructions on building the project in [README.md](https://github.com/canopas/group-track-flutter).

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. Make sure your code lints.

## Labels

Labels on issues are managed by contributors; you don't have to worry about them. Here's a list of what they mean:

- **bug**: Feature that should work, but doesn't.
- **enhancement**: Minor tweak/addition to existing behavior.
- **feature**: New behavior, bigger than enhancement.
- **question**: No need for any fix, usually a usage problem.
- **reproducible**: Has enough information to very easily reproduce, mostly in the form of a small project in a GitHub repo.
- **repro-needed**: We need some code to be able to reproduce and debug locally; otherwise, there's not much we can do.
- **duplicate**: There's another issue that already covers/tracks this.
- **wontfix**: Working as intended, or won't be fixed due to compatibility or other reasons.
- **invalid**: There isn't enough information to make a verdict, or unrelated.
- **non-library**: Issue is not in the core library code, but rather in documentation, samples, build process, or releases.

## License

By contributing to GroupTrack, you agree that your contributions will be licensed under its Apache License, Version 2.0. See the LICENSE file for details.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ GroupTrack utilizes the latest Flutter technologies and adheres to industry best
- Google Maps Flutter

## Contribution
Currently, we are not accepting any contributions.
The Canopas team enthusiastically welcomes contributions and project participation! There are a bunch of things you can do if you want to contribute! The [Contributor Guide](CONTRIBUTING.md) has all the information you need for everything from reporting bugs to contributing entire new features. Please don't hesitate to jump in if you'd like to, or even ask us questions if something isn't clear.

## Credits
GroupTrack is owned and maintained by the [Canopas team](https://canopas.com/). You can follow them on X at [@canopas_eng](https://x.com/canopas_eng) for project updates and releases. If you are interested in building apps or designing products, please let us know. We'd love to hear from you!
Expand Down

0 comments on commit 1bd2f9f

Please sign in to comment.