From 9fe91da7b027609532612e9255e0c9cc5cca3a9b Mon Sep 17 00:00:00 2001 From: Radhika Saliya <74301808+cp-radhika-s@users.noreply.github.com> Date: Fri, 20 Dec 2024 17:50:12 +0530 Subject: [PATCH] Create CONTRIBUTING.md (#136) * Create CONTRIBUTING.md --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ README.md | 3 ++- 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..46b68325 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# 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-android). +1. Fork the repo and create your branch from `master`. +2. If you've added code that should be tested, add tests +4. 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 behaviour + * **feature**: new behaviour, bigger than enhancement + * **question**: no need of 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 which 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, releases + + ## License + By contributing to GroupTrack, you agree that your contributions will be licensed under its Apache License, Version 2.0. See LICENSE file for details. diff --git a/README.md b/README.md index fd49631e..535befba 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,8 @@ GroupTrack utilizes the latest Android technologies and adheres to industry best - Hilt ## 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 Twitter 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!