Skip to content

Commit b7fbf77

Browse files
shreyasbhat0shreyasbhat0
authored
chore: add project repository structure
* chore: add pull request template * chore: define repo structure
1 parent 78d7138 commit b7fbf77

File tree

17 files changed

+587
-0
lines changed

17 files changed

+587
-0
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Description:
2+
3+
### Commit Message
4+
5+
```bash
6+
type: commit message
7+
```
8+
9+
see the [guidelines](https://github.com/icon-project/community/blob/main/guidelines/technical/software-development-guidelines.md#commit-messages) for commit messages.
10+
11+
### Changelog Entry
12+
13+
```bash
14+
version: <log entry>
15+
```
16+
17+
## Checklist:
18+
19+
- [ ] I have performed a self-review of my own code
20+
- [ ] I have documented my code in accordance with the [documentation guidelines](https://github.com/icon-project/community/blob/main/guidelines/technical/software-development-guidelines.md#documentation)
21+
- [ ] My changes generate no new warnings
22+
- [ ] I have added tests that prove my fix is effective or that my feature works
23+
- [ ] I have run the unit tests
24+
- [ ] I only have one commit (if not, squash them into one commit).
25+
- [ ] I have a descriptive commit message that adheres to the [commit message guidelines](https://github.com/icon-project/community/blob/main/guidelines/technical/software-development-guidelines.md#commit-messages)
26+
27+
> Please review the [CONTRIBUTING.md](/CONTRIBUTING.md) file for detailed contributing guidelines.

‎.gitignore

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
### Java ###
2+
# Compiled class file
3+
*.class
4+
5+
# Log file
6+
*.log
7+
8+
# BlueJ files
9+
*.ctxt
10+
11+
# Mobile Tools for Java (J2ME)
12+
.mtj.tmp/
13+
14+
# Package Files #
15+
*.jar
16+
*.war
17+
*.nar
18+
*.ear
19+
*.zip
20+
*.tar.gz
21+
*.rar
22+
23+
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
24+
hs_err_pid*
25+
replay_pid*
26+
27+
### Rust ###
28+
# Generated by Cargo
29+
# will have compiled files and executables
30+
debug/
31+
target/
32+
33+
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
34+
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
35+
Cargo.lock
36+
37+
# These are backup files generated by rustfmt
38+
**/*.rs.bk
39+
40+
# MSVC Windows builds of rustc generate these, which store debugging information
41+
*.pdb
42+
43+
### Solidity ###
44+
# Logs
45+
logs
46+
npm-debug.log*
47+
yarn-debug.log*
48+
yarn-error.log*
49+
lerna-debug.log*
50+
.pnpm-debug.log*
51+
52+
# Diagnostic reports (https://nodejs.org/api/report.html)
53+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
54+
55+
# Runtime data
56+
pids
57+
*.pid
58+
*.seed
59+
*.pid.lock
60+
61+
# Directory for instrumented libs generated by jscoverage/JSCover
62+
lib-cov
63+
64+
# Coverage directory used by tools like istanbul
65+
coverage
66+
*.lcov
67+
68+
# nyc test coverage
69+
.nyc_output
70+
71+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
72+
.grunt
73+
74+
# Bower dependency directory (https://bower.io/)
75+
bower_components
76+
77+
# node-waf configuration
78+
.lock-wscript
79+
80+
# Compiled binary addons (https://nodejs.org/api/addons.html)
81+
build/Release
82+
83+
# Dependency directories
84+
node_modules/
85+
jspm_packages/
86+
87+
# Snowpack dependency directory (https://snowpack.dev/)
88+
web_modules/
89+
90+
# TypeScript cache
91+
*.tsbuildinfo
92+
93+
# Optional npm cache directory
94+
.npm
95+
96+
# Optional eslint cache
97+
.eslintcache
98+
99+
# Optional stylelint cache
100+
.stylelintcache
101+
102+
# Microbundle cache
103+
.rpt2_cache/
104+
.rts2_cache_cjs/
105+
.rts2_cache_es/
106+
.rts2_cache_umd/
107+
108+
# Optional REPL history
109+
.node_repl_history
110+
111+
# Output of 'npm pack'
112+
*.tgz
113+
114+
# Yarn Integrity file
115+
.yarn-integrity
116+
117+
# dotenv environment variable files
118+
.env
119+
.env.development.local
120+
.env.test.local
121+
.env.production.local
122+
.env.local
123+
124+
# parcel-bundler cache (https://parceljs.org/)
125+
.cache
126+
.parcel-cache
127+
128+
# Next.js build output
129+
.next
130+
out
131+
132+
# Nuxt.js build / generate output
133+
.nuxt
134+
dist
135+
136+
# Gatsby files
137+
.cache/
138+
# Comment in the public line in if your project uses Gatsby and not Next.js
139+
# https://nextjs.org/blog/next-9-1#public-directory-support
140+
# public
141+
142+
# vuepress build output
143+
.vuepress/dist
144+
145+
# vuepress v2.x temp and cache directory
146+
.temp
147+
148+
# Docusaurus cache and generated files
149+
.docusaurus
150+
151+
# Serverless directories
152+
.serverless/
153+
154+
# FuseBox cache
155+
.fusebox/
156+
157+
# DynamoDB Local files
158+
.dynamodb/
159+
160+
# TernJS port file
161+
.tern-port
162+
163+
# Stores VSCode versions used for testing VSCode extensions
164+
.vscode-test
165+
166+
# yarn v2
167+
.yarn/cache
168+
.yarn/unplugged
169+
.yarn/build-state.yml
170+
.yarn/install-state.gz
171+
.pnp.*

‎CODEOWNERS

Whitespace-only changes.

‎CODE_OF_CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[mozilla coc]: https://github.com/mozilla/diversity
131+
[faq]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing to IBC-Integration
2+
3+
The following is a set of guidelines for contributing to IBC-Integration.
4+
5+
These guidelines are subject to change. Feel free to propose changes to this document in a pull request.
6+
7+
## Pull Request Checklist
8+
9+
Before sending your pull requests, make sure you do the following:
10+
11+
- Read the [contributing guidelines](CONTRIBUTING.md).
12+
- Check if your changes adhere to the [guidelines](https://github.com/icon-project/community/blob/main/guidelines/technical-development/development-guidelines.md).
13+
- Run the [unit tests](#running-unit-tests).
14+
15+
## Code of Conduct
16+
17+
The IBC-Integration project is governed by the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md). Participants are expected to uphold this code.
18+
19+
## Questions
20+
21+
> **Note:** Github Issues are reserved for feature requests and bug reporting. Please don't create a new Github issue to ask a question.
22+
23+
We have a vibrant developer community and several community resources to ask questions in.
24+
25+
### Community Resources
26+
27+
- [Github Discussions](https://github.com/icon-project/ibc-integration/discussions)
28+
- [ICON Official Discord](https://discord.gg/qa9m4bgKHE)
29+
30+
## How Can I Contribute?
31+
32+
### Reporting Bugs
33+
34+
Before creating bug reports, please check **[our list of issues](https://github.com/icon-project/ibc-integration/issues)** to see if an
35+
issue already exists.
36+
37+
> **Note:** For existing issues, please add a comment to the existing issue instead of opening a new issue. If the issue is closed and
38+
> the problem persists, please open a new issue and include a link to the original issue in the body of your new one.
39+
40+
When you are creating a bug report, please fill out [the required template](https://github.com/icon-project/ibc-integration/blob/main/.github/ISSUE_TEMPLATE/bug.md) and include as many details as possible.
41+
42+
### Contributing Code
43+
44+
If you want to contribute, start working through the IBC-Integration repository, navigate to the Github "issues" tab and start looking through issues. We recommed issues labeled "good first issue". These are issues that we believe are particularly well suited for newcomers. If you decide to start on an issue, leave a comment so that other people know that you're working on it. If you want to help out, but not alone, use the issue comment thread to coordinate.
45+
46+
Please see the [ICON Foundation Development Guidelines](https://github.com/icon-project/community/blob/main/guidelines/technical-development/development-guidelines.md)
47+
for information regarding our development standards and practices.
48+
49+
### IBC-Integration Core Development Process
50+
51+
This section is intended for developers and project managers that are involved with core IBC-Integration.
52+
53+
After the developer working on the branch determines the feature (or fix) branch satisfies the acceptance criteria of the associated issue and has sufficiently tested the added code, the developer should submit a pull request with at least 1 reviewer assigned for the feature branch to be merged into the main branch.
54+
55+
After the pull request has been merged, the feature branch should be deleted and the issue should be closed.

‎Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
workspace = []

0 commit comments

Comments
 (0)