Repo created
This commit is contained in:
parent
4af19165ec
commit
68073add76
12458 changed files with 12350765 additions and 2 deletions
124
docs/CONTRIBUTING.md
Normal file
124
docs/CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
# Contributing
|
||||
|
||||
Thank you for your interest in contributing to CoMaps!
|
||||
|
||||
## How Can I Contribute?
|
||||
|
||||
- [Donate](https://opencollective.com/comaps/donate)
|
||||
- [Submit a bug report or a feature request](#bug-reports-and-feature-requests)
|
||||
|
||||
There are things to do for everyone:
|
||||
- [For translators](#translations)
|
||||
- [For UI/UX and graphic designers](#ui-ux-map-styling-and-icons)
|
||||
- [For developers](#code-contributions)
|
||||
- [Day-to-day activities](#day-to-day-activities) like user support, testing, issue management, community relations, etc.
|
||||
- [Submitting your work](#submitting-your-changes)
|
||||
|
||||
If you'd like to help in any other way or if there are any related questions - please [contact us](https://codeberg.org/comaps#keep-connected).
|
||||
|
||||
### Bug Reports and Feature Requests
|
||||
|
||||
[Submit an issue](https://codeberg.org/comaps/comaps/issues) and describe your feature idea or report a bug.
|
||||
Please check if there are no similar issues already submitted by someone else.
|
||||
|
||||
When reporting a bug please provide as much information as possible: OS and application versions,
|
||||
list of actions leading to a bug, a log file produced by the app.
|
||||
|
||||
When using CoMaps app on a device, use the built-in "Report a bug" option:
|
||||
on Android it creates a new e-mail with a log file attached. Enabling logs in CoMaps settings on Android
|
||||
before sending the bug report also helps us a lot with debugging.
|
||||
|
||||
### Translations
|
||||
|
||||
CoMaps is available in 35 languages already, but some of them are incomplete and existing translations need regular updates as the app evolves.
|
||||
See [translations instructions](TRANSLATIONS.md) for details.
|
||||
|
||||
### UI/UX, map styling and icons
|
||||
|
||||
CoMaps has a strong focus on easy to use UI and smooth user experience. Feel free to join UI/UX discussions in relevant issues. Mockups are very welcome!
|
||||
|
||||
If you're into graphic design then CoMaps needs good, clear and free-to-use icons for hundreds of map features / POIs.
|
||||
Check CoMaps' [design principles](https://codeberg.org/comaps/comaps/wiki/Design-Principles). Post your icons onto relevant issues or take a next step and [integrate them](STYLES.md) yourself.
|
||||
|
||||
Check the [map styling instructions](STYLES.md) and work on adding new map features and other open map styles issues.
|
||||
|
||||
### Code Contributions
|
||||
|
||||
Please follow instructions in [INSTALL.md](INSTALL.md) to set up your development environment.
|
||||
You will find a list of issues for new contributors [here](https://codeberg.org/comaps/comaps/issues?labels=393881%2c393944) to help you get started with simple tasks.
|
||||
|
||||
**We do not assign issues to first-time contributors.** Any such request notifies our contributors and the development team, and creates unnecessary noise that distracts us from the work. Just make a PR - and it will be reviewed.
|
||||
|
||||
Sometimes it's better to discuss and confirm your vision of the fix or implementation before working on an issue. Our main focus is on simplicity and convenience for everyone, not only for geeks.
|
||||
|
||||
Please [learn how to use `git rebase`](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) (or rebase via any git tool with a graphical interface, e.g. [Fork for Mac](https://git-fork.com/) is quite good) to amend your commits in the PR and maintain a clean logical commit history for your changes/branches.
|
||||
|
||||
We strive to help onboard new developers but we don't always have enough time to guide newcomers step-by-step and explain everything in detail. For that reason we might ask you to read lots of the documentation and study the existing code.
|
||||
|
||||
- [Pull Request Guide](PR_GUIDE.md).
|
||||
- [Directories structure](STRUCTURE.md)
|
||||
- [C++ Style Guide](CPP_STYLE.md).
|
||||
- [Java Style Guide](JAVA_STYLE.md).
|
||||
- [Swift Style Guide](SWIFT_STYLE.md).
|
||||
- [Objective-C Style Guide](OBJC_STYLE.md).
|
||||
|
||||
...and more in the [docs folder](./) of the repository.
|
||||
|
||||
### Day-to-day Activities
|
||||
|
||||
Please help us:
|
||||
- processing users questions and feedback in chats, app stores, email and social media and creating follow-up issues or updating existing ones
|
||||
- reproducing and triaging reported bugs
|
||||
- [testing upcoming features and bug fixes for Android, iOS and desktop versions](TESTING.md)
|
||||
- keeping [issues](https://codeberg.org/comaps/comaps/issues) in order (check for duplicates, organize, assign labels, link related issues, etc.)
|
||||
- composing nice user-centric release notes and news items
|
||||
- etc.
|
||||
|
||||
You can also contribute in [other ways](https://codeberg.org/comaps/Governance/src/branch/main/contribute.md).
|
||||
|
||||
## Submitting your changes
|
||||
|
||||
All contributions to CoMaps repositories should be submitted via
|
||||
[pull requests](https://forgejo.org/docs/latest/user/pull-requests-and-git-flow/)
|
||||
and signed-off with the [Developers Certificate of Origin](#legal-requirements).
|
||||
|
||||
Each pull request is reviewed by CoMaps maintainers to ensure its quality.
|
||||
Sometimes the review process even for smallest commits can be very thorough.
|
||||
|
||||
### Legal Requirements
|
||||
|
||||
When contributing to this project, you must agree that you have authored 100%
|
||||
of the content, that you have the necessary rights to the content and that
|
||||
the content you contribute may be provided under the project license.
|
||||
|
||||
To contribute you must assure that you have read and are following the rules
|
||||
stated in the [Developers Certificate of Origin](DCO.md) (DCO). We have
|
||||
borrowed this procedure from the Linux kernel project to improve tracking of
|
||||
who did what, and for legal reasons.
|
||||
|
||||
To sign-off a patch, just add a line in the commit message saying:
|
||||
|
||||
Signed-off-by: Some Developer <somedev@example.com>
|
||||
|
||||
Git has a flag that can sign a commit for you. An example using it is:
|
||||
|
||||
git commit -s -m 'An example commit message'
|
||||
|
||||
Or, if you're making edits using Codeberg UI, check "Add a Signed-off-by trailer
|
||||
by the committer at the end of the commit log message" before saving.
|
||||
|
||||
You can sign-off using your pseudonym or real name, and using
|
||||
"somedev@noreply.codeberg.org" as an email instead of a real one.
|
||||
|
||||
## Team Messaging
|
||||
|
||||
If you have contributed and interested in contributing more through collaboration with the project team, you are welcome to join Zulip. Zulip is for contributors who regularly collaborate on work with the team, and it is different from Telegram, Matrix or Mastodon which are for broader discussion. If you are interested in further contributing, use this link to join the CoMaps org on Zulip chat:
|
||||
|
||||
https://comaps.zulipchat.com/join/e5e3c4zurmfxykrtbiiq6qrw/
|
||||
|
||||
When you join Zulip, in Watercooler > Signups do an intro with the team:
|
||||
- Short background, professional and personal
|
||||
- Why are you contributing to CoMaps
|
||||
- What you think about projects' principles and direction https://codeberg.org/comaps/Governance#core-principles
|
||||
- Contribution so far (link Issue, PR, etc)
|
||||
- What you would like to contribute
|
||||
Loading…
Add table
Add a link
Reference in a new issue