Skip to content

Commit 3f5bb6f

Browse files
authored
fix: contributing guidelines formatting (axelarnetwork#1159)
1 parent 1fcd9da commit 3f5bb6f

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed

CONTRIBUTING.md

+19-21
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,66 @@
1-
## Contributing to Axelar
1+
# Contributing to Axelar
22

33
We appreciate your interest in contributing to Axelar! This document `CONTRIBUTING.md` provides a high-level overview of how you can get involved.
44

5-
### Table of Contents
5+
## Table of contents
66

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)
119
- [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)
1513

16-
### Getting Started
14+
## Getting started
1715

1816
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.
1917

2018
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/).
2119

2220
---
2321

24-
### How to Contribute
22+
## How to contribute
2523

2624
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.
2725
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.
2927
4. Create a new branch for your contribution with the following command:
3028

3129
```shell
3230
git checkout -b my-fix-branch
3331
```
3432

35-
5. Make your changes in the new git branch
33+
5. Make your changes in the new git branch.
3634
6. Commit your changes. Your commit message should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
3735

3836
```shell
3937
git commit -a
4038
```
4139

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:
4341

4442
```shell
4543
git push origin my-fix-branch
4644
```
4745

4846
Open a pull request from your forked repository to the original repository.
4947

50-
If we suggest changes then:
48+
If we suggest changes:
5149

5250
- 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.
5452

5553
> If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue.
5654
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.
5856

5957
---
6058

61-
### Code of Conduct
59+
## Code of conduct
6260

6361
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.
6462

65-
#### Our Standards:
63+
### Standards
6664

6765
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.
6866

@@ -74,13 +72,13 @@ Unacceptable behavior includes:
7472
- Publishing others' confidential information without explicit permission.
7573
- Any other conduct that could be considered inappropriate in a professional setting.
7674

77-
#### Our Responsibilities:
75+
### Responsibilities
7876

7977
As project maintainers, we clarify the standards of acceptable behavior and take appropriate corrective action in response to unacceptable behavior.
8078

8179
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.
8280

83-
### Project Structure
81+
## Project structure
8482

8583
- **`src/content/`**: All documentation content in Markdown format.
8684
- **`src/layouts/navigation.ts`**: Defines the navigation structure for the documentation site.

0 commit comments

Comments
 (0)