Skip to content

Commit

Permalink
[SQUASH] Also repo updates
Browse files Browse the repository at this point in the history
  • Loading branch information
sebady committed Apr 23, 2024
1 parent 5f5a727 commit 506d5f2
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Thanks for your pull request. Please review the following guidelines.
- [ ] Commits are squashed.
- [ ] Tests added.
- [ ] Documentation added/updated.
- [ ] Also please review [CONTRIBUTING.md](https://github.com/paypal/squbs/blob/master/CONTRIBUTING.md).
- [ ] Also please review [CONTRIBUTING.md](https://github.com/squbs-org/squbs/blob/main/CONTRIBUTING.md).
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ We love your contributions. Please use the steps below to determine the path of
We all should discuss new ideas before they turn into code. The [squbs gitter chat](https://gitter.im/paypal/squbs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) is a great starting point for such discussions. Once we get to a certain conclusion, please file an issue in the [issue tracker](https://github.com/paypal/squbs/issues) with reference to the forum discussion.

## Bugs
If you have determined you are facing a bug or defect, please log the bug in the [issue tracker](https://github.com/paypal/squbs/issues). If the bug has any reference to forum discussions, please add the reference to the forum discussion.
If you have determined you are facing a bug or defect, please log the bug in the [issue tracker](https://github.com/squbs-org/squbs/issues). If the bug has any reference to forum discussions, please add the reference to the forum discussion.

## Contribution Process
The standard way of contributing ideas/features and bug fixes is by pull requests.

* Make sure you have an active github account.
* [Fork](https://help.github.com/articles/fork-a-repo/) the squbs repo into your account.
* Make modifications to the master branch. If the contribution is a bug fix that needs to go into a release branch, please provide that as a comment on the pull request (below).
* Make modifications to the main branch. If the contribution is a bug fix that needs to go into a release branch, please provide that as a comment on the pull request (below).
* Provide test cases and ensure the test coverage of the added code and functionality.
* If the change impacts documentation, please provide documentation fixes or additional documentation for the feature.
* Commit and push your contributions. The commit message must reference the issue solved by this commit.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![image](docs/img/squbs-logo-transparent.png)

[![Join the chat at https://gitter.im/paypal/squbs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/paypal/squbs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://github.com/paypal/squbs/actions/workflows/publish.yml/badge.svg)](https://github.com/paypal/squbs/actions/workflows/publish.yml)
[![Build Status](https://github.com/squbs-org/squbs/actions/workflows/publish.yml/badge.svg)](https://github.com/paypal/squbs/actions/workflows/publish.yml)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.squbs/squbs-unicomplex_2.12/badge.svg?style=flat)](http://search.maven.org/#search|ga|1|g:org.squbs)
[![License](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://opensource.org/licenses/Apache-2.0)

Expand All @@ -17,8 +17,8 @@ squbs (pronounced "skewbs") is a suite of components enabling standardization an

The easiest way to getting started is to create a project from one of the squbs templates. The followings are currently available giter8 templates:

* [squbs-scala-seed](https://github.com/paypal/squbs-scala-seed.g8): Template for creating sample squbs scala application
* [squbs-java-seed](https://github.com/paypal/squbs-java-seed.g8): Template for creating sample squbs java application
* [squbs-scala-seed](https://github.com/squbs-org/squbs-scala-seed.g8): Template for creating sample squbs scala application
* [squbs-java-seed](https://github.com/squbs-org/squbs-java-seed.g8): Template for creating sample squbs java application

## Contributing to squbs

Expand Down
6 changes: 3 additions & 3 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ lazy val `squbs-admin` = project dependsOn (`squbs-unicomplex`, `squbs-testkit`
lazy val `squbs-ext` = project dependsOn `squbs-pipeline` % "provided"

ThisBuild / pomExtra :=
<url>https://github.com/paypal/squbs</url>
<url>https://github.com/squbs-org/squbs</url>
<licenses>
<license>
<name>Apache License, Version 2.0</name>
Expand All @@ -76,8 +76,8 @@ ThisBuild / pomExtra :=
</license>
</licenses>
<scm>
<url>git@github.com:paypal/squbs.git</url>
<connection>scm:git:git@github.com:paypal/squbs.git</connection>
<url>git@github.com:squbs-org/squbs.git</url>
<connection>scm:git:git@github.com:squbs-org/squbs.git</connection>
</scm>
<developers>
<developer>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Each of the components have virtually no dependency on each others. They are tru

The easiest way to getting started is to create a project from one of the squbs templates. The followings are currently available giter8 templates:

* [squbs-scala-seed](https://github.com/paypal/squbs-scala-seed.g8): Template for creating sample squbs scala application
* [squbs-java-seed](https://github.com/paypal/squbs-java-seed.g8): Template for creating sample squbs java application
* [squbs-scala-seed](https://github.com/squbs-org/squbs-scala-seed.g8): Template for creating sample squbs scala application
* [squbs-java-seed](https://github.com/squbs-org/squbs-java-seed.g8): Template for creating sample squbs java application

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion docs/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public class SampleTest extends CustomTestKit {
}
```

The following sections show customizations only in ScalaTest; however, all these customizations are supported for TestNG and JUnit as well. For customizations, provide a `public` constructor in your TestNG/JUnit tests and call `super` with custom parameters. Check [squbs-testkit/src/test/java/org/squbs/testkit/japi](https://github.com/paypal/squbs/tree/master/squbs-testkit/src/test/java/org/squbs/testkit/japi) for more TestNG and JUnit samples.
The following sections show customizations only in ScalaTest; however, all these customizations are supported for TestNG and JUnit as well. For customizations, provide a `public` constructor in your TestNG/JUnit tests and call `super` with custom parameters. Check [squbs-testkit/src/test/java/org/squbs/testkit/japi](https://github.com/paypal/squbs/tree/main/squbs-testkit/src/test/java/org/squbs/testkit/japi) for more TestNG and JUnit samples.

Specifically for JUnit, avoid setting actor system name in your tests (letting `CustomTestKit` set the actor system name is in general a good practice though). JUnit creates a new fixture instance for each `@Test` method which potentially causes actor system conflicts. `AbstractCustomTestKit` avoids this by appending an incremented integer to each actor system name.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
site_name: squbs
theme: readthedocs
repo_url: https://github.com/paypal/squbs
edit_uri: blob/master/docs/
edit_uri: blob/main/docs/
pages:
- Overview: 'index.md'
- About:
Expand Down

0 comments on commit 506d5f2

Please sign in to comment.