Skip to content

Commit ffd0381

Browse files
committed
docs: improve the contribution guide [ci skip]
1 parent 5eea707 commit ffd0381

File tree

1 file changed

+52
-6
lines changed

1 file changed

+52
-6
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,77 @@
11
# Contributing Guide
22

3-
Thank you for your interest in contributing to our project! We welcome all contributions, from bug reports to new features.
3+
Thank you for your interest in contributing to our project! We welcome all contributions, from **bug reports** to **new
4+
features**.
45

5-
This guide will help you get started quickly.
6+
This guide will help you **get started quickly**.
67

78
## How to Contribute
89

910
There are several ways to contribute, even if you don't want to write code.
1011

1112
1. **Report a Bug:** Open an issue to tell us about something that's broken.
1213
2. **Suggest a Feature:** Open an issue to propose a new idea.
13-
3. **Fix a Bug or Implement a Feature:** Submit a Pull Request (PR) with your code changes.
14+
3. **Fix a Bug or Implement a Feature:** Submit a **Pull Request (PR)** with your code changes.
15+
16+
---
1417

1518
## Quick Start for Code Contributions
1619

1720
If you're ready to submit code, follow these steps:
1821

1922
### 1. Find an Issue
20-
Look through the [open issues](../../issues) to find something you'd like to work on. If you're new, look for labels like `good first issue` or `help wanted`. If you want to work on something new, **please open an issue to discuss it first** before writing code.
23+
24+
Look through the [open issues](../../issues) to find something you'd like to work on. If you're new, look for labels
25+
like `good first issue` or `help wanted`. If you want to work on something new, **please open an issue to discuss it
26+
first** before writing code.
2127

2228
### 2. Fork the Repository
23-
Click the "Fork" button in the top right of this repository's page. This creates your own copy of the project under your GitHub account.
29+
30+
Click the **"Fork"** button in the top right of this repository's page. This creates your own copy of the project under
31+
your GitHub account.
2432

2533
### 3. Clone Your Fork
34+
2635
Clone your forked repository to your local machine.
2736

2837
```bash
2938
git clone https://github.com/angular-ru/sdk.git
30-
cd repository-name
39+
cd sdk
40+
# Switch to the main branch.
41+
git checkout main
42+
# Create a new branch for your changes.
43+
git checkout -b my-bug-fix
3144
```
45+
46+
You can find more information about Git feature branches
47+
[here](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow).
48+
49+
### 4. Start the Project
50+
51+
1. Run `npm ci` to install dependencies.
52+
2. Run `nx serve` to serve one of the demo apps. For example:
53+
54+
```bash
55+
nx serve virtual-table-demo
56+
```
57+
58+
---
59+
60+
## Testing
61+
62+
Make sure your changes pass existing tests and that you write **new tests** for any new or changed behavior:
63+
64+
- `npm run test` to run unit tests
65+
- `npm run lint` to run the linter
66+
- `npm run build:lib:all` to build all libraries
67+
- `npm run build:app:all` to build all demo apps
68+
69+
---
70+
71+
## Pull Request Process
72+
73+
1. We follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our commit messages. For
74+
example: `feat(cdk): improve typing`
75+
2. Ensure you **cover all code changes with unit tests**.
76+
3. When you are ready, create a **Pull Request** in GitHub targeting the `main` branch.
77+
4. We will review your code and merge it if everything is okay!

0 commit comments

Comments
 (0)