Skip to content

Commit

Permalink
Easier contributions on mac (#128)
Browse files Browse the repository at this point in the history
* Ignore .DS_Store files created on MacOS

* Bind redis-server to localhost

* Update CONTRIBUTING
  • Loading branch information
robfromboulder authored Aug 14, 2024
1 parent 4f51765 commit c2d32c0
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.DS_Store
.metadata
.cache
.settings/
Expand Down
33 changes: 32 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# Code of Conduct
# Contributing to Phileas

## Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Please read and understand the [Code of Conduct](https://github.com/philterd/phileas/blob/main/CODE_OF_CONDUCT.md).

## GitHub Workflow

We prefer to take contributions as GitHub pull requests. This workflow allows you to create your own copy of Phileas, try out some changes, and then share your changes back to the community, with proper review and feedback from other Phileas contributors.

1. Create a fork of philterd/phileas
2. Create a feature branch
3. Build and test local changes
4. Commit changes to your feature branch
5. Open a pull request
6. Participate in code review
7. Celebrate your accomplishment

## Building and Testing Changes

### Required Tools

* Java 17+
* maven
* redis-server

### Building on Linux

Ubuntu is our daily driver, but any Linux distribution should work.

### Building on MacOS

In System Settings | Privacy & Security | Developer Tools, enable `Terminal` and `IntelliJ IDEA` (and other IDEs where you run tests).
Otherwise you'll get errors where `redis-server` fails to start when running tests.
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ public void before() throws IOException {
api.start();

if(!isExternalRedis) {
redisServer = RedisServer.builder().port(31000).build();
redisServer = RedisServer.builder().setting("bind 127.0.0.1").port(31000).build();
redisServer.start();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public static void beforeClass() {
public void before() throws IOException {

if(!isExternalRedis) {
redisServer = RedisServer.builder().port(31000).build();
redisServer = RedisServer.builder().setting("bind 127.0.0.1").port(31000).build();
redisServer.start();
} else {
// Clear alerts from the cache.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public static void beforeClass() {
public void before() {

if(!isExternalRedis) {
redisServer = RedisServer.builder().port(31000).build();
redisServer = RedisServer.builder().setting("bind 127.0.0.1").port(31000).build();
redisServer.start();
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public class RedisVectorBasedSpanDisambiguationServiceTest {
@BeforeEach
public void before() {

redisServer = RedisServer.builder().port(31000).build();
redisServer = RedisServer.builder().setting("bind 127.0.0.1").port(31000).build();
redisServer.start();

}
Expand Down

0 comments on commit c2d32c0

Please sign in to comment.