-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ci & doc] Add more document and setup ci github action workflow. (#1)
* [doc] Add more documents * [ci] Setup ci github action workflow.
- Loading branch information
Showing
13 changed files
with
1,030 additions
and
6 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,37 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help Starcoin to improve | ||
title: "bug: " | ||
labels: "bug" | ||
assignees: "" | ||
--- | ||
|
||
# Bug Report | ||
|
||
**Starcoin Framework version:** | ||
|
||
<!-- Please specify commit or tag version. --> | ||
|
||
**Current behavior:** | ||
|
||
<!-- Describe how the bug manifests. --> | ||
|
||
**Expected behavior:** | ||
|
||
<!-- Describe what the behavior would be without the bug. --> | ||
|
||
**Steps to reproduce:** | ||
|
||
<!-- Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. --> | ||
|
||
**Related code:** | ||
|
||
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. --> | ||
|
||
``` | ||
insert short code snippets here | ||
``` | ||
|
||
**Other information:** | ||
|
||
<!-- List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. --> |
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,32 @@ | ||
--- | ||
name: Feature Request | ||
about: Suggest an idea for this project | ||
title: "[Feature Request]: " | ||
labels: "enhancement" | ||
assignees: "" | ||
--- | ||
|
||
# Feature Request | ||
|
||
**Describe the Feature Request** | ||
|
||
<!-- A clear and concise description of what the feature request is. Please include if your feature request is related to a problem. --> | ||
|
||
**Describe Preferred Solution** | ||
|
||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
**Describe Alternatives** | ||
|
||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
**Related Code** | ||
|
||
<!-- If you are able to illustrate the bug or feature request with an example, please provide it here. --> | ||
|
||
**Additional Context** | ||
|
||
<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to add, use case, Stack Overflow links, forum links, screenshots, OS if applicable, etc. --> | ||
|
||
**If the feature request is approved, would you be willing to submit a PR?** | ||
Yes / No _(Help can be provided if you need assistance submitting a PR)_ |
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,7 @@ | ||
--- | ||
name: Codebase improvement | ||
about: Provide your feedback for the existing codebase. Suggest a better solution for algorithms, development tools, etc. | ||
title: "[Code]: " | ||
labels: "enhancement" | ||
assignees: "" | ||
--- |
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,6 @@ | ||
--- | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Starcoin Community Support | ||
url: https://github.com/starcoinorg/starcoin/discussions | ||
about: Please ask and answer questions here. |
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,33 @@ | ||
<!--- Please provide a general summary of your changes in the title above --> | ||
|
||
## Pull request type | ||
|
||
<!-- Please try to limit your pull request to one type, submit multiple pull requests if needed. --> | ||
|
||
Please check the type of change your PR introduces: | ||
|
||
- [ ] Bugfix | ||
- [ ] Feature | ||
- [ ] Code style update (formatting, renaming) | ||
- [ ] Refactoring (no functional changes, no api changes) | ||
- [ ] Build related changes | ||
- [ ] Documentation content changes | ||
- [ ] Other (please describe): | ||
|
||
## What is the current behavior? | ||
|
||
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. --> | ||
|
||
Issue Number: N/A | ||
|
||
## What is the new behavior? | ||
|
||
<!-- Please describe the behavior or changes that are being added by this PR. --> | ||
|
||
- | ||
- | ||
- | ||
|
||
## Other information | ||
|
||
<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> |
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,41 @@ | ||
name: 1. Build and Test | ||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
build-and-test: | ||
name: build and test | ||
runs-on: ubuntu-latest | ||
timeout-minutes: 20 | ||
steps: | ||
- name: checkout | ||
uses: actions/checkout@v1 | ||
with: | ||
submodules: recursive | ||
- name: setup rust toolchain | ||
uses: actions-rs/toolchain@v1 | ||
with: | ||
profile: minimal | ||
- name: setup environment | ||
run: | | ||
bash scripts/dev_setup.sh -b -t -y -p | ||
- name: build | ||
run: | | ||
source "$HOME/.profile" | ||
mpm package build | ||
- name: test | ||
run: | | ||
source "$HOME/.profile" | ||
mpm package test | ||
- name: spec test | ||
run: | | ||
source "$HOME/.profile" | ||
mpm package test | ||
- name: move-prover-test | ||
run: | | ||
source "$HOME/.profile" | ||
mpm package prove | ||
- name: check changed files | ||
run: bash ./scripts/changed-files.sh |
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,50 @@ | ||
**/target | ||
/target | ||
public | ||
resources | ||
**/*.rs.bk | ||
|
||
# macOS Specific ignores | ||
# General | ||
.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
|
||
# Thumbnails | ||
._* | ||
|
||
# Files that might appear in the root of a volume | ||
.DocumentRevisions-V100 | ||
.fseventsd | ||
.Spotlight-V100 | ||
.TemporaryItems | ||
.Trashes | ||
.VolumeIcon.icns | ||
.com.apple.timemachine.donotpresent | ||
|
||
# Directories potentially created on remote AFP share | ||
.AppleDB | ||
.AppleDesktop | ||
Network Trash Folder | ||
Temporary Items | ||
.apdisk | ||
|
||
.idea | ||
.vscode | ||
*iml | ||
|
||
# Github action's files | ||
packages-microsoft-prod.deb | ||
|
||
examples/*.mv | ||
|
||
# Move trace file. | ||
*.mvcov | ||
|
||
# Move Build Output | ||
build/ | ||
*.bak | ||
|
||
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries | ||
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html | ||
Cargo.lock |
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,45 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer using any of the [conduct@starcoin.org](mailto:conduct@starcoin.org). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html> | ||
|
||
For answers to common questions about this code of conduct, see <https://www.contributor-covenant.org/faq> |
Oops, something went wrong.