conversations-api-services

Repository to contain all conversations api services shared across our services.

Maintainers

Maintained by Phoenix ([email protected]). Contact us via #eng-team-phoenix in Slack.

Contributing

Make it easier for people to understand how they can contribute to your project. Remember that these people could be from your own team, or another team.

Example:

We welcome and appreciate any and all contributions, even if it is a typo fix to this README. When working on a larger contribution, please open an issue first, so that we can discuss the approach. Once you have your contribution ready, please open a Pull Requests containing your changes and contact us via #TEAM_SLACK_CHANNEL in Slack.

How do I use it? (Installation)

Instructions targeted at the user of your project, rather than at a co-developer in your team. This section should answer:

How to use this?

If this is an internal tool that is just used within your team, then you can share this here as well.

Development Guide

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. This section should answer:

How to get started with developing on this project?

This is essential for onboarding new members on your team but also for allowing people from outside of your team to contribute.

This Development Guide may contain different sub-sections, depending on what stack/ecosystem your project is using. Below some examples of sub-sections that apply to most projects.

Prerequisites

What things do you need to install the software and how to install them? Including links here is helpful.

Running it locally

A step-by-step series of examples that tell you how to get a development env running.

End with an example of getting some data out of the system or using it for a little demo.

Running the tests

Explain how to run the automated tests for this system.

Deployment

Add additional notes about how to deploy this on a live system. You may also want to link to the different environments where this is deployed (e.g. Staging, Production).

Monitoring & Troubleshooting

How can you inspect the system running in remote environments (Staging, Production)? This should include logs, dashboards, etc.