Skip to content

Commit 7e13791

Browse files
yusufseyrekyusufseyrek
committed
Update docs
1 parent 0e19351 commit 7e13791

File tree

9 files changed

+963
-0
lines changed

9 files changed

+963
-0
lines changed

‎Developer Documentation/aescan/.github/ISSUE_TEMPLATE/bug_report.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Bug report
3+
about: Report a bug to help us improve the application.
4+
title: ""
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
<!-- **IMPORTANT!**
10+
Before reporting a bug, please make sure that you have read through our documentation. -->
11+
12+
### Context information
13+
14+
application version: <!-- e.g. 0.4.0 -->
15+
device: <!-- e.g. PC, 2022 macbook pro, Iphone SE, Samsung Galaxy Fold 2 -->
16+
browser: <!-- e.g. Firefox 111.0 -->
17+
operating system: <!-- e.g. Ubuntu 22.04.1 -->
18+
19+
### Steps to reproduce
20+
21+
### What is expected?
22+
23+
### What is actually happening?
24+
<!-- A video or screenshots of the issue are highly appreciated -->

‎Developer Documentation/aescan/.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or enhancement for the application.
4+
title: ''
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
### Please describe the problem that your request should resolve.
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
### Describe the solution you'd like
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
### Is it already possible to achieve the same outcome in any other way? If so, how?
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
### Additional context
20+
<!-- Add any other context, screenshots or designs about the feature request go here. -->

‎Developer Documentation/aescan/.github/pull_request_template.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!--- Ensure the title of the Pull Request follows conventional commits syntax. If it resolves an issue, provide its ID in the scope section. -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
<!--- If it resolves an open issue, please link to the issue here. For example "Resolves: #137" -->
6+
<!--- If it doesn't resolve any open issues, tell us why is this change required? What problem does it solve? -->
7+
8+
## Demo
9+
<!--- Show us a video or screenshots that present the changes. Before/after comparison is very welcome -->
10+
11+
## Checklist:
12+
<!--- Put an `x` in all the boxes that apply. -->
13+
<!--- If your change requires a documentation PR, please link it appropriately -->
14+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
15+
- [ ] I have read and followed the [Contributing Guide](../../CONTRIBUTING.md)
16+
- [ ] My change requires a change to the documentation.
17+
- [ ] I have updated the documentation accordingly.

‎Developer Documentation/aescan/CHANGELOG.md

+497
Large diffs are not rendered by default.

‎Developer Documentation/aescan/CODE_OF_CONDUCT.md

+131
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
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 repository maintainers.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All repository maintainers are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
119+
120+
Community Impact Guidelines were inspired by
121+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
122+
123+
For answers to common questions about this code of conduct, see the FAQ at
124+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
125+
[https://www.contributor-covenant.org/translations][translations].
126+
127+
[homepage]: https://www.contributor-covenant.org
128+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
129+
[Mozilla CoC]: https://github.com/mozilla/diversity
130+
[FAQ]: https://www.contributor-covenant.org/faq
131+
[translations]: https://www.contributor-covenant.org/translations

‎Developer Documentation/aescan/CONTRIBUTING.md

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Aescan Contributing Guide
2+
3+
Thank you for your interest in contributing to the Aescan project. Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
4+
5+
- [Code of Conduct](https://github.com/aeternity/aescan/blob/develop/CODE_OF_CONDUCT.md)
6+
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
7+
- [Git and Pull Request Guidelines](#git-and-pull-request-guidelines)
8+
- [Development Environment Setup](https://github.com/aeternity/aescan#getting-started)
9+
- [Project Structure](#project-structure)
10+
11+
## Issue Reporting Guidelines
12+
13+
### Where to Find Known Issues
14+
15+
We will be using GitHub Issues for our public bug reports. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new issue, try to make sure your problem doesn't already exist.
16+
17+
### Reporting New Issues
18+
19+
All bug reports should be reported through Github issues and contain the following information:
20+
21+
* Release version of the application
22+
* Expected behavior
23+
* Current behavior
24+
25+
Additional images and/or videos presenting the issues, as well as known workarounds are much welcome.
26+
27+
### Feature submission
28+
29+
All future requests should be reported through Github issues and contain the following information:
30+
31+
* What problem does this feature solve?
32+
* Are there already available any alternative ways to achieve similar results? If yes, please, describe them
33+
34+
## Git and Pull Request Guidelines
35+
36+
If you are planning to fix an issue present in our latest release or implement a new feature, please follow the simplified flow described below:
37+
38+
* Create your own fork of the repository (maintainers may use the main repository).
39+
* Originate your new branch that will contain the changes from the `develop` branch.
40+
* Implement the changes. Respect currently implemented coding restrictions and guidelines.
41+
* Run code linting through `npm run lint:fix` command and correct any issues that couldn't be automatically fixed.
42+
* Push the new branch to your forked repository and open a Pull Request against the `develop` branch. Use the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) pattern for the PR name.
43+
* Wait until your Pull Request is approved by the required number of maintainers and all automated checks are green
44+
* Merge the pull request
45+
46+
Note: It's OK to have multiple small commits as you work on the PR - GitHub will automatically squash it before merging.
47+
48+
* Requirements for adding a new feature:
49+
* If you resolving a specific issue, add `feat(xxxx): [description]` (xxxx is the issue id) in your PR title for a better release log, e.g. `feat(360): add contract icons in Contracts view`.
50+
* Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
51+
52+
* Requirements for fix of a bug:
53+
* In case you are resolving a specific issue, add `fix(xxxx): [description]` (xxxx is the issue id) in your PR title for a better release log, e.g. `fix(420): filtering dropdown doesn't work on Safari`.
54+
* Provide a detailed description of the bug in the PR. Live demo preferred.
55+
56+
For detailed information about our branching strategy or instructions on dealing with other scenarios, please read our [Branching Strategy](./docs/BRANCHING_STRATEGY.md) guidelines.
57+
58+
## Project Structure
59+
60+
* **`dist`**: contains built files that will be used for hosting the application using express.js webserver. The content of this directory is generated automatically during building process. Do not put there any files manually.
61+
62+
* **`docs`**: contains basic project documentation in a form of markdown files.
63+
64+
* **`public`**: contains static assets that are meant to be publically available with guaranteed path. As opposed to the assets stored in src directory, during building process the name of these files will stay unchanged.
65+
66+
* **`src`**: contains the source code of the application. The codebase is written in ES2020.
67+
68+
* **`assets`**: contains static assets that are meant to be publically available but the exact path will change with every build by adding an additional unique suffix to the name.
69+
70+
* **`components`**: contains (mostly) reusable Vue components.
71+
72+
* **`plugins`**: contains code for implementing third-party services, mostly related to tracking.
73+
74+
* **`router`**: contains the definition of all routes available in the application and informs which views are associated to these routes.
75+
76+
* **`stores`**: contains global data obtaining and storage structures implemented using Pinia
77+
78+
* **`styles`**: contains global css snippets that are applied across the entire application.
79+
80+
* **`utils`**: contains reusable helpers not directly tied to any specific business logic, and data adapters.
81+
82+
* **`views`**: contains Vue components that represent all pages (known as views) of the application.
83+
84+
* `App.vue`: is the root Vue component of the application.
85+
86+
* `main.js`: is the entry point of the application where the critical subsystems are initialized.
87+
88+
* `server.js`: is a simple express.js application used to serve the static data intended to use until the Server-side Rendering is fully implemented.
89+
90+
## Credits
91+
Thank you to all the people who already contributed to the aeScan! You can find the complete list of them on [this page](https://github.com/aeternity/aescan/graphs/contributors).

‎Developer Documentation/aescan/LICENSE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
ISC License
2+
3+
Copyright (c) 2023, æternity developers
4+
5+
Permission to use, copy, modify, and/or distribute this software for any
6+
purpose with or without fee is hereby granted, provided that the above
7+
copyright notice and this permission notice appear in all copies.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
10+
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11+
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
12+
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13+
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14+
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15+
PERFORMANCE OF THIS SOFTWARE.

0 commit comments

Comments
 (0)