-
Notifications
You must be signed in to change notification settings - Fork 448
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
*: reorganize project package structure
Signed-off-by: Lonng <[email protected]>
- Loading branch information
Showing
41 changed files
with
1,457 additions
and
1,264 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: "\U0001F41B Bug Report" | ||
labels: "bug" | ||
about: Something isn't working as expected | ||
|
||
--- | ||
|
||
## Bug Report | ||
|
||
Please answer these questions before submitting your issue. Thanks! | ||
|
||
1. What did you do? If possible, provide a recipe for reproducing the error. | ||
|
||
2. What did you expect to see? | ||
|
||
3. What did you see instead? | ||
|
||
4. Versions of the `nano` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: "\U0001F680 Feature Request" | ||
labels: "feature-request" | ||
about: I have a suggestion | ||
|
||
--- | ||
|
||
## Feature Request | ||
|
||
**Is your feature request related to a problem? Please describe:** | ||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> | ||
|
||
**Describe the feature you'd like:** | ||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
**Describe alternatives you've considered:** | ||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
**Teachability, Documentation, Adoption, Optimization:** | ||
<!-- If you can, explain some scenarios how users might use this, situations it would be helpful in. Any API designs, mockups, or diagrams are also helpful. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
name: "\U0001F914 Question" | ||
labels: "question" | ||
about: Usage question that isn't answered in docs or discussion | ||
|
||
--- | ||
|
||
## Question | ||
|
||
Before asking a question, make sure you have: | ||
|
||
- Searched existing Stack Overflow questions. | ||
- Googled your question. | ||
- Searched open and closed [GitHub issues](https://github.com/lonng/nano/issues?q=is%3Aissue) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<!-- | ||
Thank you for contributing to Nano! Please read the [CONTRIBUTING](https://github.com/lonng/nano/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR. | ||
--> | ||
|
||
### What problem does this PR solve? <!--add issue link with summary if exists--> | ||
|
||
|
||
### What is changed and how it works? | ||
|
||
|
||
### Check List <!--REMOVE the items that are not applicable--> | ||
|
||
Tests <!-- At least one of them must be included. --> | ||
|
||
- Unit test | ||
- Integration test | ||
- Manual test (add detailed scripts or steps below) | ||
- No code | ||
|
||
Side effects | ||
|
||
- Possible performance regression | ||
- Increased code complexity | ||
- Breaking backward compatibility | ||
|
||
Related changes | ||
|
||
- Need to cherry-pick to the release branch | ||
- Need to update the documentation | ||
- Need to be included in the release note |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
# How to contribute | ||
|
||
This document outlines some of the conventions on development workflow, commit | ||
message formatting, contact points and other resources to make it easier to get | ||
your contribution accepted. | ||
|
||
## Getting started | ||
|
||
- Fork the repository on GitHub. | ||
- Read the README.md for build instructions. | ||
- Play with the project, submit bugs, submit patches! | ||
|
||
## Building Nano | ||
|
||
Developing Nano requires: | ||
|
||
* [Go 1.12](http://golang.org/doc/code.html) | ||
* An internet connection to download the dependencies | ||
|
||
Simply run `make` to build the program. | ||
|
||
```sh | ||
make | ||
``` | ||
|
||
### Running tests | ||
|
||
This project contains unit tests and integration tests with coverage collection. | ||
See [tests/README.md](./tests/README.md) for how to execute and add tests. | ||
|
||
### Updating dependencies | ||
|
||
Failpoint manages dependencies using [Go module](https://github.com/golang/go/wiki/Modules). | ||
To add or update a dependency, either | ||
|
||
* Use the `go mod edit` command to change the dependency, or | ||
* Edit `go.mod` and then run `make update` to update the checksum. | ||
|
||
## Contribution flow | ||
|
||
This is a rough outline of what a contributor's workflow looks like: | ||
|
||
- Create a topic branch from where you want to base your work. This is usually `master`. | ||
- Make commits of logical units and add test case if the change fixes a bug or adds new functionality. | ||
- Run tests and make sure all the tests are passed. | ||
- Make sure your commit messages are in the proper format (see below). | ||
- Push your changes to a topic branch in your fork of the repository. | ||
- Submit a pull request. | ||
- Your PR must receive LGTMs from two maintainers. | ||
|
||
Thanks for your contributions! | ||
|
||
### Code style | ||
|
||
The coding style suggested by the Golang community is used in `failpoint`. | ||
See the [style doc](https://github.com/golang/go/wiki/CodeReviewComments) for details. | ||
|
||
Please follow this style to makeg `failpoint` easy to review, maintain and develop. | ||
|
||
### Format of the Commit Message | ||
|
||
We follow a rough convention for commit messages that is designed to answer two | ||
questions: what changed and why. The subject line should feature the what and | ||
the body of the commit should describe the why. | ||
|
||
``` | ||
restore: add comment for variable declaration | ||
Improve documentation. | ||
``` | ||
|
||
The format can be described more formally as follows: | ||
|
||
``` | ||
<subsystem>: <what changed> | ||
<BLANK LINE> | ||
<why this change was made> | ||
<BLANK LINE> | ||
<footer>(optional) | ||
``` | ||
|
||
The first line is the subject and should be no longer than 70 characters, the | ||
second line is always blank, and other lines should be wrapped at 80 characters. | ||
This allows the message to be easier to read on GitHub as well as in various | ||
git tools. | ||
|
||
If the change affects more than one subsystem, you can use comma to separate them like `code,examples:`. | ||
|
||
If the change affects many subsystems, you can use ```*``` instead, like ```*:```. | ||
|
||
For the why part, if no specific reason for the change, | ||
you can use one of some generic reasons like "Improve documentation.", | ||
"Improve performance.", "Improve robustness.", "Improve test coverage." | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Maintainers | ||
|
||
This file lists who are the core maintainers of the nano project. | ||
|
||
## Project Lead | ||
|
||
* [Lonng](https://github.com/lonng) | ||
|
||
## Other Core Maintainers | ||
|
||
* None | ||
|
||
|
Oops, something went wrong.