-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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
Showing
6 changed files
with
37 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
.DS_Store | ||
.metadata | ||
.cache | ||
.settings/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters