You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We appreciate your interest in contributing to Axelar! This document `CONTRIBUTING.md` provides a high-level overview of how you can get involved.
4
4
5
-
###Table of Contents
5
+
## Table of contents
6
6
7
-
-[Contributing to Axelar](#contributing-to-axelar)
8
-
-[Table of Contents](#table-of-contents)
9
-
-[Getting Started](#getting-started)
10
-
-[How to Contribute](#how-to-contribute)
7
+
-[Getting Started](#getting-started)
8
+
-[How to contribute](#how-to-contribute)
11
9
-[Code of Conduct](#code-of-conduct)
12
-
-[Our Standards:](#our-standards)
13
-
-[Our Responsibilities:](#our-responsibilities)
14
-
-[Project Structure](#project-structure)
10
+
-[Standards](#our-standards)
11
+
-[Responsibilities](#our-responsibilities)
12
+
-[Project structure](#project-structure)
15
13
16
-
###Getting Started
14
+
## Getting started
17
15
18
16
If you are new to the Axelar Network, we encourage you to read the [Axelar Documentation](https://docs.axelar.network/) to learn more about the Axelar Network and how to get started.
19
17
20
18
If you are new to contributing to open-source projects, we encourage you to read [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).
21
19
22
20
---
23
21
24
-
###How to Contribute
22
+
## How to contribute
25
23
26
24
1. Before you submit your Pull Request (PR), search the project for an open or closed PR related to your submission. You don't want to duplicate effort.
27
25
2. Fork the repository within your user and clone it to your local machine.
28
-
3. Install the dependencies for the project as indicated in the README.md
26
+
3. Install the dependencies for the project as indicated in the README.
29
27
4. Create a new branch for your contribution with the following command:
30
28
31
29
```shell
32
30
git checkout -b my-fix-branch
33
31
```
34
32
35
-
5. Make your changes in the new git branch
33
+
5. Make your changes in the new git branch.
36
34
6. Commit your changes. Your commit message should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
37
35
38
36
```shell
39
37
git commit -a
40
38
```
41
39
42
-
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. Push your branch to GitHub with the following command:
40
+
**Note:** the optional commit `-a` command line option will automatically "add" and "rm" edited files. Push your branch to GitHub with the following command:
43
41
44
42
```shell
45
43
git push origin my-fix-branch
46
44
```
47
45
48
46
Open a pull request from your forked repository to the original repository.
49
47
50
-
If we suggest changes then:
48
+
If we suggest changes:
51
49
52
50
- Make the required updates and commit them to your branch.
53
-
- Wait for the project maintainer to review your changes and merge your Pull Request.
51
+
- Wait for the project maintainer to review your changes and merge your pull request.
54
52
55
53
> If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue.
56
54
57
-
When you open a new issue, please provide as much detail as possible, including steps to reproduce the problem and the expected behavior. Even better, you can submit a Pull Request with a fix.
55
+
When you open a new issue, please provide as much detail as possible, including steps to reproduce the problem and the expected behavior. Even better, you can submit a pull request with a fix.
58
56
59
57
---
60
58
61
-
###Code of Conduct
59
+
## Code of conduct
62
60
63
61
We pledge to create a harassment-free experience for everyone in our project and community, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
64
62
65
-
#### Our Standards:
63
+
###Standards
66
64
67
65
We expect all participants to use welcoming and inclusive language, respect differing viewpoints and experiences, gracefully accept constructive criticism, focus on what's best for the community, and show empathy towards other members.
- Publishing others' confidential information without explicit permission.
75
73
- Any other conduct that could be considered inappropriate in a professional setting.
76
74
77
-
#### Our Responsibilities:
75
+
###Responsibilities
78
76
79
77
As project maintainers, we clarify the standards of acceptable behavior and take appropriate corrective action in response to unacceptable behavior.
80
78
81
79
We also reserve the right to remove or reject any contributions that do not align with this Code of Conduct or to temporarily or permanently ban any contributor who exhibits inappropriate, threatening, offensive, or harmful behavior.
82
80
83
-
###Project Structure
81
+
## Project structure
84
82
85
83
-**`src/content/`**: All documentation content in Markdown format.
86
84
-**`src/layouts/navigation.ts`**: Defines the navigation structure for the documentation site.
0 commit comments