Skip to content

Commit

Permalink
Staging (#42)
Browse files Browse the repository at this point in the history
* producer example bugfix

* version update

* update readme

* update readme

* add  the client ip address of a producer

* remove the IP from the msg headers

* add max msg deliveries option

* add the connection id as a header

* remove the jenkins file

* update readme file

* add missing files

* typo

* pull consumer bugfix

* defaults consumer group to consumer name

* readme update
  • Loading branch information
idanasulin2706 authored Jul 11, 2022
1 parent 8e8c3ba commit 1ccee2a
Show file tree
Hide file tree
Showing 11 changed files with 607 additions and 885 deletions.
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Memphis Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
Email.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
189 changes: 189 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
# Contributing

We would ❤️ it if you contributed to the project and helped make Memphis{dev} even better.<br>
We will make sure that contributing to Memphis{dev} is easy, enjoyable, and educational for anyone and everyone.<br>
All contributions are welcome, including features, issues, documentation, guides, and more.

Our beloved contributors also recieve occasional Memphis Swag Pack and publications where every Memphis is!

![contribution tweet](https://user-images.githubusercontent.com/70286779/173819239-3611bbb2-3f7d-41a2-ad37-2e966b91403c.jpg)

<hr>
<div align="center">

<h1>Process</h1>

![contribution guidelinues](https://user-images.githubusercontent.com/70286779/173803841-1c77d8d9-d378-4632-872d-c782ce61f2a3.png)

</div>

## Step 1: Choose a task

[Open tasks table](https://github.com/orgs/memphisdev/projects/1)

## Step 2: Make a fork

Fork the Memphis-broker repository to your GitHub organization. This means that you'll have a copy of the repository under _your-GitHub-username/repository-name_.

## Step 3: Clone the repository to your local machine

```
git clone https://github.com/{your-GitHub-username}/memphis-<component>.git
```

## Step 4: Start a dev environment

### For the broker
https://github.com/memphisdev/memphis-broker

Run the following docker-compose, it will start a local Memphis environment without the Broker
```
curl -s https://memphisdev.github.io/memphis-docker/docker-compose-dev-broker.yaml -o docker-compose.yaml && \
docker compose -f docker-compose.yaml -p memphis up
```

Run locally via VS code debugger

Install GO, and then -
```
go get -d -v .
go install -v .
```
and then click F5 in order to start the debugger

### For the UI
https://github.com/memphisdev/memphis-ui

Run the following docker-compose, it will start a local Memphis environment without the UI
```
curl -s https://memphisdev.github.io/memphis-docker/docker-compose-dev-ui.yaml -o docker-compose.yaml && \
docker compose -f docker-compose.yaml -p memphis up
```

Inside the cloned directory
```
npm install
npm start
```

### Tech stack

**Server-side**
- [Go](https://go.dev/) (Broker / SDK)
- [Python](https://www.python.org/) (SDK)
- [Node.JS](https://nodejs.org/) (CLI / SDK)

**Client-side**
- [React](https://reactjs.org/docs/getting-started.html) (UI)

**Scripting**
- [Helm](https://helm.sh/) (Deployment)
- [Docker](https://docker.com) (Deployment)
- [Bash](https://www.gnu.org/software/bash/) (Deployment)

## Step 5: Create a branch

Create a new branch (from staging branch) for your fix.

```jsx
git checkout -b branch-name-here staging
```

## Step 6: Make your changes

Update the code with your bug fix or new feature.

## Step 7: Add the changes that are ready to be committed

Stage the changes that are ready to be committed:

```jsx
git add .
```

## Step 8: Commit the changes (Git)

Commit the changes with a short message. (See below for more details on how we structure our commit messages)

```jsx
git commit -m "<type>(<package>): <subject>"
```

## Step 9: Push the changes to the remote repository

Push the changes to the remote repository using:

```jsx
git push origin branch-name-here
```

## Step 10: Create Pull Request

In GitHub, do the following to submit a pull request to the upstream repository (staging branch):

1. Give the pull request a title and a short description of the changes made. Include also the issue or bug number associated with your change. Explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer.

Remember, it's okay if your pull request is not perfect (no pull request ever is). The reviewer will be able to help you fix any problems and improve it!

2. Wait for the pull request to be reviewed by a maintainer.

3. Make changes to the pull request if the reviewing maintainer recommends them.

Celebrate your success after your pull request is merged :-)

## Git Commit Messages

We structure our commit messages like this:

```
<type>(<package>): <subject>
```

Example

```
fix(server): missing entity on init
```

## Got a question?

You can ask questions, consult with more experienced Memphis{dev} users, and discuss Memphis-related topics in the our [Discord channel](https://discord.gg/WZpysvAeTf).

## Found a bug?

If you find a bug in the source code, you can help us by [submitting an issue](https://github.com/memphisdev/memphis-broker/issues/new?assignees=&labels=type%3A%20bug) to our GitHub Repository.<br>
Even better, you can submit a Pull Request with a fix.

## Missing a feature?

You can request a new feature by [submitting an issue](https://github.com/memphisdev/memphis-broker/issues/new?assignees=&labels=type%3A%20feature%20request) to our GitHub Repository.

If you'd like to implement a new feature, it's always good to be in touch with us before you invest time and effort, since not all features can be supported.

- For a Major Feature, first open an issue and outline your proposal. This will let us coordinate efforts, prevent duplication of work, and help you craft the change so that it's successfully integrated into the project.
- Small Features can be crafted and directly [submitted as a Pull Request](#submit-pr).

### Types:

- **feat**: A new feature
- **fix**: A bug fix
- **docs**: Changes to the documentation
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
- **refactor**: A code change that neither fixes a bug nor adds a feature
- **perf**: A code change that improves performance
- **test**: Adding missing or correcting existing tests
- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation

### Packages:

- **server**
- **client**
- **data-service-gen**

## Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

[Code of Conduct](https://github.com/memphisdev/memphis-broker/blob/master/code_of_conduct.md)

Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy.
39 changes: 0 additions & 39 deletions Jenkinsfile

This file was deleted.

9 changes: 9 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
### Maintainers
- Idan Asulin <idan@memphis.dev> [@idanasulinmemphis](https://github.com/idanasulinmemphis)
- Avraham Neeman <avraham@memphis.dev> [@avrhamNeeman](https://github.com/avrhamNeeman)
- Valera Bronshtein <valera@memphis.dev> [@valeraBr](https://github.com/valeraBr)
- Yaniv Ben Hemo <yaniv@memphis.dev> [@yanivbh1](https://github.com/yanivbh1)
- Sveta Gimpelson <sveta@memphis.dev> [@SvetaMemphis](https://github.com/SvetaMemphis)
- Shay Bratslavsky <shay@memphis.dev> [@shay23b](https://github.com/shay23b)
- Or Grinberg <or@memphis.dev> [@orgrMmphs](https://github.com/orgrMmphs)
- Shoham Roditi <shoham@memphis.dev> [@shohamroditimemphis](https://github.com/shohamroditimemphis)
Loading

0 comments on commit 1ccee2a

Please sign in to comment.