Skip to content

Commit 68a0c76

Browse files
committed
Update CONTRIBUTING.md
1 parent 8261618 commit 68a0c76

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

python/pyabacus/CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,27 @@
44

55
Welcome to the `pyabacus` project! This document provides guidelines and instructions for developers who want to contribute to this project.
66

7+
`pyabacus` is a Python interface for the ABACUS package. It provides a high-level Python API for interacting with the ABACUS library, allowing users to perform electronic structure calculations and analyze the results using Python.
8+
9+
<!-- toc -->
10+
11+
- [Project structure](#project-structure)
12+
* [Root CMake Configuration](#root-cmake-configuration)
13+
* [Module CMake Configuration](#module-cmake-configuration)
14+
- [Development Process](#development-process)
15+
16+
<!-- tocstop -->
17+
18+
If you are new to the project, please refer to the [README.md](../README.md) file for an overview of the project and its goals.
19+
20+
If you are already familiar with the project and want to contribute, this guide will help you understand the project structure, development process, and best practices for contributing code.
21+
22+
If you have any questions or need help, feel free to reach out to the maintainers or create an issue in the repository.
23+
24+
Please feel free to contribute to this guide by submitting a pull request with any improvements or additional information.
25+
26+
Let's get started!
27+
728
## Project Structure
829

930
The project is organized as follows:
@@ -12,7 +33,12 @@ The project is organized as follows:
1233
pyabacus/
1334
├── CMakeLists.txt
1435
└── src
36+
├── pyabacus
37+
│ └── {your_module}
38+
│ ├── {interface}.py
39+
│ └── __init__.py
1540
└── {your_module}
41+
├── {your_code}.cpp
1642
└── CMakeLists.txt
1743
```
1844

0 commit comments

Comments
 (0)