Skip to content

Commit d38e2f9

Browse files
LeoBoraiLeoBorai
committed
feat: contrib guidelines, better ci
1 parent 8ddbac7 commit d38e2f9

27 files changed

+1151
-397
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!--
2+
Thank you for your pull request. Please provide a description of your change.
3+
4+
Contributors guide: https://github.com/rust-lang-ve/rust-lang-ve.github.io/blob/HEAD/CONTRIBUTING.md
5+
-->
6+
7+
<!--
8+
Developer's Certificate of Origin 1.1
9+
10+
By making a contribution to this project, I certify that:
11+
12+
(a) The contribution was created in whole or in part by me and I
13+
have the right to submit it under the open source license
14+
indicated in the file; or
15+
16+
(b) The contribution is based upon previous work that, to the best
17+
of my knowledge, is covered under an appropriate open source
18+
license and I have the right under that license to submit that
19+
work with modifications, whether created in whole or in part
20+
by me, under the same open source license (unless I am
21+
permitted to submit under a different license), as indicated
22+
in the file; or
23+
24+
(c) The contribution was provided directly to me by some other
25+
person who certified (a), (b) or (c) and I have not modified
26+
it.
27+
28+
(d) I understand and agree that this project and the contribution
29+
are public and that a record of the contribution (including all
30+
personal information I submit with it, including my sign-off) is
31+
maintained indefinitely and may be redistributed consistent with
32+
this project or the open source license(s) involved.
33+
-->

‎.github/workflows/ci.yml

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: CI
2+
on:
3+
pull_request:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
ci:
10+
runs-on: ubuntu-latest
11+
strategy:
12+
matrix:
13+
rust:
14+
- stable
15+
- beta
16+
- nightly
17+
18+
steps:
19+
- uses: actions/checkout@v2
20+
21+
- uses: actions-rs/toolchain@v1
22+
with:
23+
profile: minimal
24+
toolchain: ${{ matrix.rust }}
25+
override: true
26+
components: rustfmt, clippy
27+
28+
- name: build
29+
uses: actions-rs/cargo@v1
30+
with:
31+
command: build
32+
33+
- name: test
34+
uses: actions-rs/cargo@v1
35+
with:
36+
command: test
37+
38+
- name: fmt
39+
uses: actions-rs/cargo@v1
40+
with:
41+
command: fmt
42+
args: --all -- --check
43+
44+
- name: clippy
45+
uses: actions-rs/cargo@v1
46+
with:
47+
command: clippy
48+
args: -- -D warnings

‎.github/workflows/deploy-gh-pages.yml ‎.github/workflows/deploy.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
name: Deploy GitHub Pages
1+
name: Deploy to GitHub Pages
22
on:
33
push:
44
branches:
5-
- develop
5+
- main
66

77
jobs:
8-
build-and-deploy:
8+
deploy:
99
runs-on: ubuntu-latest
1010

1111
steps:
@@ -26,5 +26,5 @@ jobs:
2626
uses: JamesIves/[email protected]
2727
with:
2828
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
29-
BRANCH: master
29+
BRANCH: gh-pages
3030
FOLDER: dist

‎.gitignore

+147-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,153 @@
1+
# MacOS
2+
.DS_Store
3+
.AppleDouble
4+
.LSOverride
5+
Icon
6+
._*
7+
.DocumentRevisions-V100
8+
.fseventsd
9+
.Spotlight-V100
10+
.TemporaryItems
11+
.Trashes
12+
.VolumeIcon.icns
13+
.com.apple.timemachine.donotpresent
14+
.AppleDB
15+
.AppleDesktop
16+
Network Trash Folder
17+
Temporary Items
18+
.apdisk
19+
20+
# Linux
21+
*~
22+
.fuse_hidden*
23+
.directory
24+
.Trash-*
25+
.nfs*
26+
27+
# Windows
28+
Thumbs.db
29+
Thumbs.db:encryptable
30+
ehthumbs.db
31+
ehthumbs_vista.db
32+
*.stackdump
33+
[Dd]esktop.ini
34+
$RECYCLE.BIN/
35+
*.cab
36+
*.msi
37+
*.msix
38+
*.msm
39+
*.msp
40+
*.lnk
41+
42+
# Binaries for programs and plugins
43+
*.exe
44+
*.exe~
45+
*.dll
46+
*.so
47+
*.dylib
48+
49+
# Test binary, built with `go test -c`
50+
*.test
51+
52+
# Output of the go coverage tool, specifically when used with LiteIDE
53+
*.out
54+
55+
# Dependency directories (remove the comment below to include it)
56+
vendor/
57+
58+
# Compiled source #
59+
###################
60+
*.com
61+
*.class
62+
*.dll
63+
*.exe
64+
*.o
65+
*.so
66+
dist/
67+
68+
# Packages #
69+
############
70+
# it's better to unpack these files and commit the raw source
71+
# git has its own built in compression methods
72+
*.7z
73+
*.dmg
74+
*.gz
75+
*.iso
76+
*.jar
77+
*.rar
78+
*.tar
79+
*.zip
80+
81+
# OS generated files #
82+
######################
83+
.DS_Store
84+
.DS_Store?
85+
._*
86+
.Spotlight-V100
87+
.Trashes
88+
ehthumbs.db
89+
Thumbs.db
90+
91+
# JavaScript #
92+
##############
93+
node_modules/
94+
bundle
95+
yarn.lock
96+
97+
# Golang Builds #
98+
#################
99+
__debug_bin
100+
101+
# Compiled source #
102+
###################
103+
*.com
104+
*.class
105+
*.dll
106+
*.exe
107+
*.o
108+
*.so
109+
dist/
110+
111+
# Packages #
112+
############
113+
# it's better to unpack these files and commit the raw source
114+
# git has its own built in compression methods
115+
*.7z
116+
*.dmg
117+
*.gz
118+
*.iso
119+
*.jar
120+
*.rar
121+
*.tar
122+
*.zip
123+
124+
# OS generated files #
125+
######################
126+
.DS_Store
127+
.DS_Store?
128+
._*
129+
.Spotlight-V100
130+
.Trashes
131+
ehthumbs.db
132+
Thumbs.db
133+
134+
# JavaScript #
135+
##############
136+
node_modules/
137+
bundle
138+
yarn-error.log
139+
.vendor-new
140+
141+
# Rust #
142+
########
1143
/target
2144
**/*.rs.bk
3145
Cargo.lock
146+
wasm-pack.log
147+
148+
# Project #
149+
###########
150+
.vscode/
4151
bin/
5152
pkg/
6153
dist/
7-
wasm-pack.log
8-
node_modules
9-
yarn-error.log

‎CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)