This is an automated email from the ASF dual-hosted git repository.
yiconghuang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/texera.git
The following commit(s) were added to refs/heads/main by this push:
new 3357371bd3 docs: update paths in contributing guide (#4018)
3357371bd3 is described below
commit 3357371bd31d0bdb7e930384fe4619e55d5501a8
Author: Andy Zhang <[email protected]>
AuthorDate: Wed Nov 12 02:45:07 2025 +0000
docs: update paths in contributing guide (#4018)
<!--
Thanks for sending a pull request (PR)! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
[Contributing to
Texera](https://github.com/apache/texera/blob/main/CONTRIBUTING.md)
2. Ensure you have added or run the appropriate tests for your PR
3. If the PR is work in progress, mark it a draft on GitHub.
4. Please write your PR title to summarize what this PR proposes, we
are following Conventional Commits style for PR titles as well.
5. Be sure to keep the PR description updated to reflect all changes.
-->
### What changes were proposed in this PR?
<!--
Please clarify what changes you are proposing. The purpose of this
section
is to outline the changes. Here are some tips for you:
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
3. If it is a refactoring, clarify what has been changed.
3. It would be helpful to include a before-and-after comparison using
screenshots or GIFs.
4. Please consider writing useful notes for better and faster reviews.
-->
This PR updates paths in the contributing guide to reflect the file
reorganization a few weeks ago.
### Any related issues, documentation, discussions?
<!--
Please use this section to link other resources if not mentioned
already.
1. If this PR fixes an issue, please include `Fixes #1234`, `Resolves
#1234`
or `Closes #1234`. If it is only related, simply mention the issue
number.
2. If there is design documentation, please add the link.
3. If there is a discussion in the mailing list, please add the link.
-->
The re-orgnization plan #3846
### How was this PR tested?
<!--
If tests were added, say they were added here. Or simply mention that if
the PR
is tested with existing test cases. Make sure to include/update test
cases that
check the changes thoroughly including negative and positive cases if
possible.
If it was tested in a way different from regular unit tests, please
clarify how
you tested step by step, ideally copy and paste-able, so that other
reviewers can
test and check, and descendants can verify in the future. If tests were
not added,
please describe why they were not added and/or why it was difficult to
add.
-->
N/A
### Was this PR authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this
PR,
please include the phrase: 'Generated-by: ' followed by the name of the
tool
and its version. If no, write 'No'.
Please refer to the [ASF Generative Tooling
Guidance](https://www.apache.org/legal/generative-tooling.html) for
details.
-->
No.
---
CONTRIBUTING.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c7ee791daf..f3b0dfdd5e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -57,18 +57,18 @@ Do not include any of the following in your PR:
### Final Steps Before Review
#### Your PR should pass scalafix check (lint) and scalafmt check.
-- To check lint, under `core` run command `sbt "scalafixAll --check"`; to fix
lint issues, run `sbt scalafixAll`.
-- To check format, under `core` run command `sbt scalafmtCheckAll`; to fix
format, run `sbt scalafmtAll`.
+- To check lint, under the root directory run command `sbt "scalafixAll
--check"`; to fix lint issues, run `sbt scalafixAll`.
+- To check format, under the root directory run command `sbt
scalafmtCheckAll`; to fix format, run `sbt scalafmtAll`.
- When you need to execute both, scalafmt is supposed to be executed after
scalafix.
#### Testing the backend
-1. The test framework is `scalatest`, for the amber engine, tests are located
under `amber/src/test`; for `WorkflowCompilingService`, tests are located under
`core/workflow-compiling-service`. You can find unit tests and e2e tests.
-2. To execute it, navigate to `core` directory in the command line and execute
`sbt test`.
+1. The test framework is `scalatest`, for the amber engine, tests are located
under `amber/src/test`; for `WorkflowCompilingService`, tests are located under
`workflow-compiling-service/src/test`. You can find unit tests and e2e tests.
+2. To execute it, navigate to the root directory in the command line and
execute `sbt test`.
3. If using IntelliJ to execute the test cases please make sure to be at the
correct working directory.
* For the amber engine's tests, the working directory should be `amber`
-* For the other services' tests, the working directory should be `core`
+* For the other services' tests, the working directory should be the root
directory
#### Testing the frontend
Before merging your code to the master branch, you need to pass the existing
unit tests first.
-1. Open a command line. Navigate to the `core/gui` directory.
+1. Open a command line. Navigate to the `frontend` directory.
2. Start the test:
```
ng test --watch=false
