You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@answer.apache.org by li...@apache.org on 2024/02/05 03:26:52 UTC

(incubator-answer-website) branch main updated (894f43d0 -> 2a39a4d4)

This is an automated email from the ASF dual-hosted git repository.

linkinstar pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-answer-website.git


    from 894f43d0 fix(link): fix invalid link for installation #149
     new a9e1db76 docs(blog): add a new blog for contribution
     new 2a39a4d4 docs(blog): update blog

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../index.md                                       |  72 +++++++++++++++++++++
 static/img/blog/2024-02-04-cover@2x.png            | Bin 0 -> 14454 bytes
 static/img/blog/2024-02-04-cover@4x.png            | Bin 0 -> 30498 bytes
 3 files changed, 72 insertions(+)
 create mode 100644 blog/2024-02-04-must-read-notes-for-your-first-answer-contribution/index.md
 create mode 100644 static/img/blog/2024-02-04-cover@2x.png
 create mode 100644 static/img/blog/2024-02-04-cover@4x.png


(incubator-answer-website) 01/02: docs(blog): add a new blog for contribution

Posted by li...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

linkinstar pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-answer-website.git

commit a9e1db76eb54c2a81a160bf782ce7f949c72dfe2
Author: LinkinStars <li...@foxmail.com>
AuthorDate: Sun Feb 4 17:44:25 2024 +0800

    docs(blog): add a new blog for contribution
---
 .../index.md                                       |  72 +++++++++++++++++++++
 static/img/blog/2024-02-04-cover@2x.png            | Bin 0 -> 14454 bytes
 static/img/blog/2024-02-04-cover@4x.png            | Bin 0 -> 30498 bytes
 3 files changed, 72 insertions(+)

diff --git a/blog/2024-02-04-must-read-notes-for-your-first-answer-contribution/index.md b/blog/2024-02-04-must-read-notes-for-your-first-answer-contribution/index.md
new file mode 100644
index 00000000..0a2a5c66
--- /dev/null
+++ b/blog/2024-02-04-must-read-notes-for-your-first-answer-contribution/index.md
@@ -0,0 +1,72 @@
+---
+title: "Must-Read Notes for Your First Answer Contribution"
+authors: [LinkinStar]
+category: Community
+featured: true
+image: 2024-02-04-cover@4x.png
+description: "I want to contribute code to answers, so what do I need to be concerned about when contributing for the first time?"
+
+---
+
+> I want to contribute code to Answer, so what do I need to be concerned about when contributing for the first time?
+
+This blog I want to talk about the first contribution to Answer. I hope this blog can help you to contribute to Answer more professionally.
+
+## Steps to contribute
+When you start contributing, you need to follow the following steps:
+1. Find or create an issue.
+2. You were assigned to the issue.
+3. Submit a pull request.
+4. Wait for the pull request to be reviewed.
+5. Make changes if necessary.
+6. The pull request is merged.
+
+## Issue First
+Before you start contributing, you need to find an issue to work on. If issue doesn't exist, you need to create one first. BTW, the `good first issue` is a label means that the issue is friendly to new contributors. So you can find this kind of issue to start your contribution.
+
+- I'm trying to work out a bug, so I need to create an issue first.
+- I'm trying to add a new feature, so I need to create an issue first.
+- I'm trying to improve the documentation, so I need to create an issue first.
+- ...
+
+Create an issue and let us know that you plan on creating a pull request for it. If an issue already exists, please comment on that issue letting us know you would like to submit a pull request for it. **This helps us to keep track of the pull request and make sure there isn't duplicated effort.** After we assign the issue to you, you can start working on it.
+
+## Choose the right branch
+Which branch should you choose when you submit your PR?
+
+- The `main` branch corresponds to the **latest version** of answer. If you're doing a **fix** for the latest version, then select the main branch.
+- The `dev` branch is for the **next version**, so if you're working on a **new feature**, checkout of the dev branch and PR for it.
+
+Normally, we mark milestones on an issue to keep track of which version the issue should be fixed in. So you can check which version you should commit to based on the milestone.
+
+## Code of Conduct
+Apache Answer has adopted a Code of Conduct that we expect project participants to adhere to. Please read the [full text](https://www.apache.org/foundation/policies/conduct.html) so that you can understand what actions will and will not be tolerated.
+
+## Code Style
+When you start contributing, you need to follow the code style.
+
+- [FRONTEND](https://answer.apache.org/community/development#code-conventions)
+- [BACKEND](https://answer.apache.org/community/development#code-conventions-1)
+
+## License
+Normally, your contributions do not import third-party dependencies. However, if you encounter such a situation, you must import a third-party dependency. **Then you need to make sure that the license of the dependency is one that meets Apache's requirements.** If you are not sure if the requirements are met, you can ask us before submitting your PR.
+
+## Commit message
+When you start contributing, you need to follow the [commit message format](https://answer.apache.org/community/pull-request#semantic-commit-messages).
+
+## Testing
+This is a very important part of contributing. When you finish your code, you need to test your code to make sure that your code is working correctly. 
+
+1. Compile your code to make sure that your code can build successfully.
+2. Run and test your code to make sure that features are working correctly.
+3. If you have no environment to test, such as Windows, you can ask us to help you test.
+
+## Make sure ASF headers
+If you add new files, please make sure that the file has the ASF header. You can run the following command to add the ASF header automatically.
+
+```bash
+$ make lint
+```
+
+## Summary
+Follow the above and your PR will be merged faster. We are looking forward to your first contribution. Let's make Answer better together.
\ No newline at end of file
diff --git a/static/img/blog/2024-02-04-cover@2x.png b/static/img/blog/2024-02-04-cover@2x.png
new file mode 100644
index 00000000..01e346ba
Binary files /dev/null and b/static/img/blog/2024-02-04-cover@2x.png differ
diff --git a/static/img/blog/2024-02-04-cover@4x.png b/static/img/blog/2024-02-04-cover@4x.png
new file mode 100644
index 00000000..96850408
Binary files /dev/null and b/static/img/blog/2024-02-04-cover@4x.png differ


(incubator-answer-website) 02/02: docs(blog): update blog

Posted by li...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

linkinstar pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-answer-website.git

commit 2a39a4d445142fdddd83333bddd29d7a9d7a7f51
Author: LinkinStars <li...@foxmail.com>
AuthorDate: Mon Feb 5 11:25:59 2024 +0800

    docs(blog): update blog
---
 .../index.md                                             | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/blog/2024-02-04-must-read-notes-for-your-first-answer-contribution/index.md b/blog/2024-02-04-must-read-notes-for-your-first-answer-contribution/index.md
index 0a2a5c66..c84c3858 100644
--- a/blog/2024-02-04-must-read-notes-for-your-first-answer-contribution/index.md
+++ b/blog/2024-02-04-must-read-notes-for-your-first-answer-contribution/index.md
@@ -4,16 +4,16 @@ authors: [LinkinStar]
 category: Community
 featured: true
 image: 2024-02-04-cover@4x.png
-description: "I want to contribute code to answers, so what do I need to be concerned about when contributing for the first time?"
+description: "Before the debut, check the must-read notes to ensure your first Answer contribution shines."
 
 ---
 
 > I want to contribute code to Answer, so what do I need to be concerned about when contributing for the first time?
 
-This blog I want to talk about the first contribution to Answer. I hope this blog can help you to contribute to Answer more professionally.
+In this blog, I want to talk about the first contribution to Answer. This blog aims to help you contribute to Answer more professionally.
 
-## Steps to contribute
-When you start contributing, you need to follow the following steps:
+## Steps to Contribute
+When start contributing, here are the steps to you need to follow:
 1. Find or create an issue.
 2. You were assigned to the issue.
 3. Submit a pull request.
@@ -22,7 +22,7 @@ When you start contributing, you need to follow the following steps:
 6. The pull request is merged.
 
 ## Issue First
-Before you start contributing, you need to find an issue to work on. If issue doesn't exist, you need to create one first. BTW, the `good first issue` is a label means that the issue is friendly to new contributors. So you can find this kind of issue to start your contribution.
+Before start contributing, you need to find an issue to work on. If issue doesn't exist, you need to create one first. BTW, the `good first issue` is a label means that the issue is friendly to new contributors. So you can find this kind of issue to start your contribution.
 
 - I'm trying to work out a bug, so I need to create an issue first.
 - I'm trying to add a new feature, so I need to create an issue first.
@@ -31,7 +31,7 @@ Before you start contributing, you need to find an issue to work on. If issue do
 
 Create an issue and let us know that you plan on creating a pull request for it. If an issue already exists, please comment on that issue letting us know you would like to submit a pull request for it. **This helps us to keep track of the pull request and make sure there isn't duplicated effort.** After we assign the issue to you, you can start working on it.
 
-## Choose the right branch
+## Choose the Right Branch
 Which branch should you choose when you submit your PR?
 
 - The `main` branch corresponds to the **latest version** of answer. If you're doing a **fix** for the latest version, then select the main branch.
@@ -61,7 +61,7 @@ This is a very important part of contributing. When you finish your code, you ne
 2. Run and test your code to make sure that features are working correctly.
 3. If you have no environment to test, such as Windows, you can ask us to help you test.
 
-## Make sure ASF headers
+## Double Check the ASF Headers
 If you add new files, please make sure that the file has the ASF header. You can run the following command to add the ASF header automatically.
 
 ```bash
@@ -69,4 +69,4 @@ $ make lint
 ```
 
 ## Summary
-Follow the above and your PR will be merged faster. We are looking forward to your first contribution. Let's make Answer better together.
\ No newline at end of file
+Following these steps helps us merge PRs efficiently. We can't wait to see your first contribution that shapes Answer better.
\ No newline at end of file