зеркало из https://github.com/dotnet/tye.git
Update readme and stuff
This commit is contained in:
Родитель
c0d533430b
Коммит
40aaefb281
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report about something that is not working
|
||||
labels: bug
|
||||
---
|
||||
|
||||
### Describe the bug
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
### To Reproduce
|
||||
<!--
|
||||
What steps can we follow to reproduce the issue?
|
||||
|
||||
|
||||
Got Exceptions? Include both the message and the stack trace
|
||||
-->
|
||||
|
||||
### Further technical details
|
||||
|
||||
- Include the output of `tye --version`
|
||||
- If possible rerun the command with `-v debug` and include the output
|
||||
- The platfrom (Linux/macOS/Windows)
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
name: Discussion
|
||||
about: Ask a question or start a discussion
|
||||
labels: discussion
|
||||
---
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
name: Feedback
|
||||
about: Tell us what you think!
|
||||
labels: feedback
|
||||
---
|
||||
|
||||
### Some details
|
||||
|
||||
**How many services are in your application? (including things like databases, redis):**
|
||||
|
||||
- [ ] 1-2
|
||||
- [ ] 3-5
|
||||
- [ ] 6-10
|
||||
- [ ] 10+
|
||||
|
||||
**What did you use tye for?**
|
||||
|
||||
- [ ] Local development
|
||||
- [ ] Deployment
|
||||
|
||||
**How is your code organized?**
|
||||
|
||||
- [ ] One service per repo
|
||||
- [ ] Many services in one big repo
|
||||
- [ ] Other (please explain)
|
||||
|
||||
### What did you think of tye?
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
name: Idea
|
||||
about: Ideas, feature requests, and wishes
|
||||
labels: idea
|
||||
---
|
||||
|
||||
### What should we add or change to make your life better?
|
||||
|
||||
### Why is this important to you?
|
|
@ -0,0 +1,70 @@
|
|||
# How to contribute
|
||||
|
||||
One of the easiest ways to contribute is to participate in discussions on GitHub issues. At this point in the tye project we welcome anyone's feedback on where tye help you to succeed or caused you trouble.
|
||||
|
||||
You can also contribute by submitting pull requests with code changes to address an open issue, or improve documentation.
|
||||
|
||||
## General feedback and discussions?
|
||||
|
||||
Create a [feedback issue](https://github.com/dotnet/tye/issues/new?template=feedback.md).
|
||||
|
||||
We know that there's a lot of diversity in how people work, think, and organize projects. We'd love to know if tye is a good fit for the way that you do your best work.
|
||||
|
||||
If we don't have follow up discussions or questions, we'll probably close your issue with a simple "Thanks!", and link it to some other issues that we're tracking. Getting feedback in the form of issues is helpful to the team, regardless of whether its negative or positive.
|
||||
|
||||
---
|
||||
|
||||
Or if there's a top if you want to discuss, create a [discussion issue](https://github.com/dotnet/tye/issues/new?template=discussion.md).
|
||||
|
||||
Feel free to create discussion issues if there's something you want ask about. We may close your issue if there's an easy answer, or we may leave it open so that others are encouraged to comment and share their point of view.
|
||||
|
||||
## Bugs and feature requests?
|
||||
|
||||
For non-security related bugs, log a new [bug issue](https://github.com/dotnet/tye/issues/new?template=bug.md).
|
||||
|
||||
Keep in mind that tye is an experimental project. We do care about the quality of the features that we're building, but we don't plan to address every bug quickly because the lifespan of the project is short.
|
||||
|
||||
---
|
||||
|
||||
For feature requests, log a new [idea issue](https://github.com/dotnet/tye/issues/new?template=idea.md).
|
||||
|
||||
Tye is an experimental project with a short roadmap. We plan to at least be honest about what ideas we think we can accomplish within the scope of the project. We might say no, or "not now" to lots of ideas as a result.
|
||||
|
||||
## Reporting security issues and bugs
|
||||
|
||||
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://technet.microsoft.com/en-us/security/ff852094.aspx).
|
||||
|
||||
## Contributing code and content
|
||||
|
||||
We accept fixes and features! Here are some resources to help you get started on how to contribute code or new content.
|
||||
|
||||
* Look at the [Developer documentation](/docs/developer_guide.md) to get started on building the source code on your own.
|
||||
* ["Help wanted" issues](https://github.com/dotnet/tye/labels/help%20wanted) - these issues are up for grabs. Comment on an issue if you want to create a fix.
|
||||
* ["Good first issue" issues](https://github.com/dotnet/tye/labels/good%20first%20issue) - we think these are a good for newcomers.
|
||||
|
||||
### Before you send a pull request
|
||||
|
||||
We prefer to have a discussion via an issues before reviewing a PR especially if the changes are extensive or if the PR adds a feature that we haven't agreed to add.
|
||||
|
||||
If you are sending a PR for an existing issue, please comment on the issue so that others can see that someone is working on it. It may not be a bad idea to comment before you start work, because the team might have suggestions.
|
||||
|
||||
We don't expect an issue for minor improvements like:
|
||||
|
||||
- Correcting grammar or spelling
|
||||
- Correcting documentation mistakes
|
||||
|
||||
### Submitting a pull request
|
||||
|
||||
You will need to sign a [Contributor License Agreement](https://cla.dotnetfoundation.org/) when submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to follow the instructions provided by the CLA bot when you send the pull request. This needs to only be done once for any .NET Foundation OSS project.
|
||||
|
||||
If you don't know what a pull request is read this article: https://help.github.com/articles/using-pull-requests. Make sure the repository can build and all tests pass.
|
||||
|
||||
Familiarize yourself with the [developer guide](/docs/developer_guide.md) for information about how to work with the repository.
|
||||
|
||||
### Tests
|
||||
|
||||
Tye is a new project with lots of aspects that are dificult to test. We don't currently have many tests as part of the repository and expect to increase the test coverage over time. For right now, try to understand if the area you're working in is already covered by tests, and expand them if possible.
|
||||
|
||||
## Code of conduct
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
37
README.md
37
README.md
|
@ -1,30 +1,47 @@
|
|||
# Tye
|
||||
|
||||
Tye is a tool that makes developing, testing, and deploying microservices and distributed applications easier. Project Tye includes a local orchestrator to make developing microservices easier and the ability to deploy microservices to Kubernetes with minimal configuration.
|
||||
|
||||
What tye can do:
|
||||
|
||||
- Run multiple projects locally.
|
||||
- Easily manage dependencies running containers.
|
||||
- Automatically build Docker images by following .NET's conventions.
|
||||
- Generate manifests for Kubenetes (static deployments/services, Helm Charts, OAM).
|
||||
- Express relationships and dependencies between services.
|
||||
- Deploy applications to Kubernetes with minimal configuration.
|
||||
- Make secret management and service discovery easy.
|
||||
- Let you configure all of this with C# code (`.csx`) or yaml!
|
||||
|
||||
## Current Status
|
||||
|
||||
![CI](https://github.com/dotnet/tye/workflows/CI/badge.svg)
|
||||
Tye is an open source experiment that will last at least until Nov 2020. We are using this time to try radical ideas to improve microservices developer productivity and see what works.
|
||||
|
||||
Tye is the combination of [Opulence](https://github.com/rynowak/opulence) and [Micronetes](https://github.com/davidfowl/micronetes) into a single tool.
|
||||
We plan to do releases with new features roughly every 4 weeks.
|
||||
|
||||
There's not much to see here right now, but keep watching this space for updates.
|
||||
For the duration of the experiment, consider every part of the tye experience to be volatile. We will frequently make additions and changes to features that seem polished. We welcome feedback from anyone who's willing to be an early-adopter with tye; the team wants to know what's working well, and what's missing to build a whole-package .NET microservices developer productivity suite.
|
||||
|
||||
## Installing the tye CLI
|
||||
---
|
||||
|
||||
TBD
|
||||
[![Build Status](https://dnceng.visualstudio.com/internal/_apis/build/status/dotnet/tye/dotnet-tye-CI?branchName=master)](https://dnceng.visualstudio.com/internal/_build/latest?definitionId=788&branchName=master)
|
||||
|
||||
## Getting started
|
||||
|
||||
TBD
|
||||
## Getting Started
|
||||
|
||||
See the getting started instructions and tutorials [here](/docs/getting_started.md).
|
||||
|
||||
|
||||
## How to Engage, Contribute, and Give Feedback
|
||||
|
||||
Some of the best ways to contribute are to try things out, file issues, join in design conversations, and make pull-requests.
|
||||
|
||||
- Download our latest daily builds
|
||||
- Try tutorials and working with your own projects
|
||||
- Log issues if you find problems, or if you have suggestions.
|
||||
- Log an issue if you have feedback you want to share with the team.
|
||||
|
||||
Check out the [contributing](/CONTRIBUTING.md) page to see the best places to log issues and start discussions.
|
||||
|
||||
## Reporting security issues and bugs
|
||||
|
||||
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.
|
||||
|
||||
## Code of conduct
|
||||
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
TODO
|
|
@ -0,0 +1 @@
|
|||
TODO
|
Загрузка…
Ссылка в новой задаче