mirror of
https://github.com/bellingcat/ukraine-timemap.git
synced 2026-06-08 03:18:36 +03:00
65 lines
2.5 KiB
Markdown
65 lines
2.5 KiB
Markdown
# Contributing to TimeMap
|
|
|
|
First and foremost, thank you so much. We really appreciate you take the time to try and contribute and make TimeMap better for those who use it.
|
|
|
|
#### Contributing means many things
|
|
|
|
Contributing can indeed be about contributing code or creating an issue, but can also take many other forms, and this document is an attempt to describing what are all the possible ways in which you can contribute.
|
|
|
|
- Updating or correcting documentation
|
|
- Fixing an open issue
|
|
- Requesting a feature
|
|
- Reporting a bug
|
|
|
|
If you're new to this project, you could check the issues that are tagged ["good first issue"](https://github.com/forensic-architecture/timemap/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). These are generally those that are considered easy ways in.
|
|
|
|
#### Showing support for TimeMap
|
|
|
|
Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use.
|
|
|
|
There are other ways in which you can contribute to the communal success of this project, such as starring the [project](https://github.com/forensic-architecture/timemap) on Github.
|
|
|
|
## Getting Started
|
|
|
|
- Make sure you have a [GitHub account](https://github.com/signup/free)
|
|
- Fork the repository on GitHub
|
|
|
|
## Issues
|
|
|
|
WIP
|
|
|
|
### Before creating an issue
|
|
|
|
Try to follow these guidelines:
|
|
|
|
- **Investigate the issue**: WIP
|
|
- **See if a ticket already exists**: WIP
|
|
- **Ask the community**: WIP
|
|
- **Proceed in creating your issue**: WIP
|
|
|
|
### Creating an issue
|
|
|
|
WIP
|
|
|
|
## Pull Requests
|
|
|
|
### Before making changes
|
|
|
|
WIP. Here we'll describe what the expected process and workflow is when making code changes, with regards to branching, forking and so on.
|
|
|
|
### Submitting changes as Pull Requests
|
|
|
|
WIP
|
|
|
|
## Additional resources
|
|
|
|
More information will be available on the [git workflow wiki page](https://github.com/forensic-architecture/timemap/wiki).
|
|
|
|
You can also refer to Github's guide to [forking a repository](https://help.github.com/articles/fork-a-repo/) and to [syncing a fork](https://help.github.com/articles/syncing-a-fork/).
|
|
|
|
If you have any questions or just want to chat, please join our team [fa_open_source](https://keybase.io/team/fa_open_source) on Keybase for community discussion. Keybase is a great platform for encrypted chat and file sharing.
|
|
|
|
## Other
|
|
|
|
This contributing guide is based on the guidelines of the [SuperCollider contributing guide](https://raw.githubusercontent.com/supercollider/supercollider/develop/CONTRIBUTING.md).
|