diff --git a/docs/CITATIONS.md b/docs/CITATIONS.md index 2b1eb7bc..d4e97183 100644 --- a/docs/CITATIONS.md +++ b/docs/CITATIONS.md @@ -1,7 +1,7 @@ # How to Cite -The following references are required to be cited when using ABACUS. Specifically: +The following references are required to be cited when using DeePTB. Specifically: - **For general purpose:** - Gu, Qiangqiang, et al. "DeePTB: A deep learning-based tight-binding approach with $ ab$ $ initio $ accuracy." arXiv preprint arXiv:2307.04638 (2023). \ No newline at end of file + Gu, Qiangqiang, et al. "DeePTB: A deep learning-based tight-binding approach with $ ab$ $ initio $ accuracy." arXiv preprint arXiv:2307.04638 (2023). diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 56902fc3..fd4c737c 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -20,13 +20,13 @@ For more non-technical aspects, please refer to the [DeePTB Contribution Guide]( ## Got a question? -Please referring to our GitHub [issue tracker](https://github.com/deepmodeling/abacus-develop/issues), and our developers are willing to help. +Please referring to our GitHub [issue tracker](https://github.com/deepmodeling/DeePTB/issues), and our developers are willing to help. If you find a bug, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a patch. You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, and that ensures your work collaborates with our development road map well. For a major feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. ## Structure of the package -Please refer to [our instructions](./quick_start/easy_install.md) on how to installing ABACUS. +Please refer to [our instructions](./quick_start/easy_install.md) on how to installing DeePTB. The source code of ABACUS is based on several modules. Under the ABACUS root directory, there are the following folders: - `cmake`: relevant files for finding required packages when compiling the code with cmake; @@ -90,7 +90,7 @@ For those who are interested in the source code, the following figure shows the ## Submitting an Issue -Before you submit an issue, please search the issue tracker, and maybe your problem has been discussed and fixed. You can [submit new issues](https://github.com/deepmodeling/abacus-develop/issues/new/choose) by filling our issue forms. +Before you submit an issue, please search the issue tracker, and maybe your problem has been discussed and fixed. You can [submit new issues](https://github.com/deepmodeling/DeePTB/issues/new/choose) by filling our issue forms. To help us reproduce and confirm a bug, please provide a test case and building environment in your issue. ## Comment style for documentation diff --git a/docs/community/contribution_guide.md b/docs/community/contribution_guide.md index f64d7d8e..9190d39f 100644 --- a/docs/community/contribution_guide.md +++ b/docs/community/contribution_guide.md @@ -1,16 +1,16 @@ -# ABACUS Contribution Guide +# DeePTB Contribution Guide ## Contribution Process -We welcome contributions from the open source community. The technical guide is provided in [Contributing to ABACUS](../CONTRIBUTING.md). Here is the basic contribution process: +We welcome contributions from the open source community. The technical guide is provided in [Contributing to DeePTB](../CONTRIBUTING.md). Here is the basic contribution process: - **Find out issues to work on.** -We assume you already have a good idea on what to do, otherwise the [issue tracker](https://github.com/deepmodeling/abacus-develop/issues) and [discussion](https://github.com/deepmodeling/abacus-develop/discussions) panel provide good starting points to find out what to work on and to get familiar with the project. +We assume you already have a good idea on what to do, otherwise the [issue tracker](https://github.com/deepmodeling/DeePTB/issues) and [discussion](https://github.com/deepmodeling/DeePTB/discussions) panel provide good starting points to find out what to work on and to get familiar with the project. - **Approach the issue.** -It is suggested to [submit new issues](https://github.com/deepmodeling/abacus-develop/issues/new/choose) before coding out changes to involve more discussions and suggestions from development team. Refer to the technical guide in [Contributing to ABACUS](../CONTRIBUTING.md) when needed. +It is suggested to [submit new issues](https://github.com/deepmodeling/DeePTB/issues/new/choose) before coding out changes to involve more discussions and suggestions from development team. Refer to the technical guide in [Contributing to DeePTB](../CONTRIBUTING.md) when needed. -- **Open a pull request.** The ABACUS developers review the pull request (PR) list regularly. If the work is not ready, convert it to draft until finished, then you can mark it as "Ready for review". It is suggested to open a new PR through forking a repo and creating a new branch on you Github account. A new PR should include as much information as possible in `description` when submmited. Unittests or CI tests are required for new PRs. +- **Open a pull request.** The DeePTB developers review the pull request (PR) list regularly. If the work is not ready, convert it to draft until finished, then you can mark it as "Ready for review". It is suggested to open a new PR through forking a repo and creating a new branch on you Github account. A new PR should include as much information as possible in `description` when submmited. Unittests or CI tests are required for new PRs. - **Iterate the pull request.** All pull requests need to be tested through CI before reviewing. A pull request might need to be iterated several times before accepted, so splitting a long PR into parts reduces reviewing difficulty for us.