mirror of
https://github.com/wassname/talk.git
synced 2026-06-29 03:05:24 +08:00
Andrew Losowsky
63850acf73
We haven't been using that. We use google doc instead, which isn't public because it contains a lot of WaPo notes.
78 lines
3.8 KiB
Markdown
78 lines
3.8 KiB
Markdown
# Contributor's Guide
|
|
|
|
Welcome! We are very excited that you are interested in contributing to Talk.
|
|
|
|
This document is a companion to help you approach contributing. If it does not do so, please [let us know how we can improve it](https://github.com/coralproject/talk/issues)!
|
|
|
|
By contributing to this project you agree to the [Code of Conduct](https://coralproject.net/code-of-conduct.html).
|
|
|
|
## Product Roadmap
|
|
|
|
You can view what the Coral Team is working on next here https://www.pivotaltracker.com/n/projects/1863625.
|
|
|
|
If you'd like to see our longer term roadmap, [get in touch.](https://coralproject.net/contact.html)
|
|
|
|
|
|
## Contribute to the documentation
|
|
|
|
Clear docs are a prerequisite for a successful open source project. We value non-code and code contributions equally.
|
|
|
|
We are looking for _documentarians_ to:
|
|
|
|
* make clarity, grammar and completeness updates,
|
|
* create new / missing sections, and
|
|
* take the lead in making sections, or the over all structure better.
|
|
|
|
### But how?
|
|
|
|
* Our public docs site can be updated [here](https://github.com/coralproject/docs).
|
|
* [Let us know](https://github.com/coralproject/talk/wiki/Contact-Us) if you'd like permission to update our wiki.
|
|
* Update any of our .md docs files by following [this guide](https://github.com/coralproject/talk/wiki/Forking,-Branching-and-Merging).
|
|
* Our API docs need to be kept honest. [Update them here](https://github.com/coralproject/talk/blob/master/docs/swagger.yaml).
|
|
|
|
## Integrate into your environment
|
|
|
|
First, [set up a dev environment](https://github.com/coralproject/talk/blob/master/INSTALL.md). Please let us know how this goes!
|
|
|
|
Talk is designed to integrate into existing environments in a variety of ways:
|
|
|
|
* [Auth integrations](https://github.com/coralproject/talk/wiki/Security#authentication-strategies)
|
|
* [Push assets into Talk](https://github.com/coralproject/talk/blob/master/routes/api/assets/index.js)
|
|
* Monitoring Hooks (coming in 2017)
|
|
|
|
If you're considering deploying Talk, [please let us know](https://github.com/coralproject/talk/wiki/Contact-Us)! We are quite literally doing this for you and want to help you succeed any way we can.
|
|
|
|
If you are writing custom integration code in your fork of Talk, please consider keeping it generic and filing a Pull Request to contribute it back to the project! See our [forking and merging guidelines](https://github.com/coralproject/talk/wiki/Forking,-Branching-and-Merging) for more info.
|
|
|
|
## Write some code
|
|
|
|
First, [set up a dev environment](https://github.com/coralproject/talk/blob/master/INSTALL.md). Please let us know how this goes!
|
|
|
|
### Build a New Feature / Plugin
|
|
|
|
Talk is beginning life as a Commenting Platform, but is architected to support many varieties of community engagement.
|
|
|
|
Please [contact us](https://github.com/coralproject/talk/wiki/Contact-Us) early and often if you'd like to help. We would love to hear your ideas for features and plugins and help you find a way to productively engage the project.
|
|
|
|
To get an idea of where the Coral Team is going, see:
|
|
|
|
* our [Slack channel](https://coralprojectslackin.herokuapp.com/), where you can talk directly with the Team and other community members,
|
|
* our [current stories](https://www.pivotaltracker.com/n/projects/1863625), and
|
|
* our [issues](https://github.com/coralproject/talk/issues).
|
|
|
|
|
|
Examples:
|
|
|
|
* [Add An Emoji Button to Comments](https://github.com/coralproject/talk/wiki/Add-An-Emoji-Button-to-Comments)
|
|
|
|
|
|
### Work on the Core
|
|
|
|
There is always more work to be done to make an application more stable, scaleable and secure.
|
|
|
|
If you see issues in the code or have ideas on how we may improve Talk, please consider:
|
|
|
|
* [contributing a fix](https://github.com/coralproject/talk/wiki/Forking,-Branching-and-Merging),
|
|
* [filing an issue](https://github.com/coralproject/talk/issues), or
|
|
* or otherwise [letting us know](https://github.com/coralproject/talk/wiki/Contact-Us).
|