We welcome pull requests! Follow these steps to contribute:
We welcome pull requests! Follow these steps to contribute:
1. Find an [issue](https://github.com/saenzramiro/rambox/issues) that needs assistance.
1. Find an [issue](https://github.com/saenzramiro/rambox/issues) that needs assistance.
1. Let us know you are working on it by posting a comment on the issue.
1. Follow the [Contribution Guidelines](#contribution-guidelines) to start working on the issue.
2. Let us know you are working on it by posting a comment on the issue.
Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
3. Follow the [Contribution Guidelines](#contribution-guidelines) to start working on the issue.
##### If you've found a bug that is not on the board, [follow these steps](README.md#found-a-bug).
Working on your first Pull Request? You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub]
Congratulations, you now have a local copy of the rambox repo!
Congratulations, you now have a local copy of the rambox repo!
@ -112,13 +108,13 @@ Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short
To create a branch on your local machine (and switch to this branch):
To create a branch on your local machine (and switch to this branch):
```shell
```shell
$ git checkout -b [name_of_your_new_branch]
git checkout -b [name_of_your_new_branch]
```
```
and to push to GitHub:
and to push to GitHub:
```shell
```shell
$ git push origin [name_of_your_new_branch]
git push origin [name_of_your_new_branch]
```
```
**If you need more help with branching, take a look at [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches).**
**If you need more help with branching, take a look at [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches).**
@ -145,12 +141,13 @@ cp env-sample.js env.js
# Windows
# Windows
copy env-sample.js env.js
copy env-sample.js env.js
```
```
Then edit the `env.js` file and modify the API keys only for services that you will use.
Then edit the `env.js` file and modify the API keys only for services that you will use.
```bash
```bash
# Compile the files...
# Compile the files...
$ sencha app watch
sencha app watch
$ npm start # in a new terminal
npm start # in a new terminal
```
```
### Make Changes
### Make Changes
@ -159,12 +156,10 @@ This bit is up to you!
#### How to find the code in the rambox codebase to fix/edit
#### How to find the code in the rambox codebase to fix/edit
The best way to find out any code you wish to change/add or remove is using
The best way to find out any code you wish to change/add or remove is using the GitHub search bar at the top of the repository page.
the GitHub search bar at the top of the repository page. For example, you could
For example, you could search for a challenge name and the results will display all the files along with line numbers.
search for a challenge name and the results will display all the files along
Then you can proceed to the files and verify this is the area that you were looking forward to edit.
with line numbers. Then you can proceed to the files and verify this is the area
Always feel free to reach out to the chat room when you are not certain of any thing specific in the code.
that you were looking forward to edit. Always feel free to reach out to the chat
room when you are not certain of any thing specific in the code.
#### Adding or Editing Services
#### Adding or Editing Services
@ -178,71 +173,46 @@ To see these changes you'll need to stop your `npm start` and `sencha app watch`
#### What is a Pull Request?
#### What is a Pull Request?
A pull request (PR) is a method of submitting proposed changes to the rambox
A pull request (PR) is a method of submitting proposed changes to the rambox repo (or any repo, for that matter).
repo (or any repo, for that matter). You will make changes to copies of the
You will make changes to copies of thefiles which make up rambox in a personal fork, then apply to have them accepted by rambox proper.
files which make up rambox in a personal fork, then apply to have them
accepted by rambox proper.
#### Important: ALWAYS EDIT ON A BRANCH
#### Important: ALWAYS EDIT ON A BRANCH
Take away only one thing from this document: Never, **EVER**
Take away only one thing from this document: Never, **EVER** make edits to the `staging` branch.
make edits to the `staging` branch. ALWAYS make a new branch BEFORE you edit
ALWAYS make a new branch BEFORE you edit files.
files. This is critical, because if your PR is not accepted, your copy of
This is critical, because if your PR is not accepted, your copy of staging will be forever sullied and the only way to fix it is to delete your fork and re-fork.
staging will be forever sullied and the only way to fix it is to delete your
fork and re-fork.
### Common Steps
### Common Steps
1. Once the edits have been committed, you will be prompted to create a pull
1. Once the edits have been committed, you will be prompted to create a pull request on your fork's GitHub Page.
request on your fork's GitHub Page.
1. By default, all pull requests should be against the rambox main repo, `staging` branch.
- **Make sure that your Base Fork is set to saenzramiro/rambox when raising a Pull Request.**
2. By default, all pull requests should be against the rambox main repo, `staging`
1. Submit a pull request.
branch.
1. The title (also called the subject) of your PR should be descriptive of your changes and succinctly indicates what is being fixed.
**Make sure that your Base Fork is set to saenzramiro/rambox when raising a Pull Request.**
3. Submit a pull request.
4. The title (also called the subject) of your PR should be descriptive of your
changes and succinctly indicates what is being fixed.
- **Do not add the issue number in the PR title or commit message.**
- **Do not add the issue number in the PR title or commit message.**
- Examples: `Added Service servicename``Correct typo in menu`
- Examples: `Added Service servicename``Correct typo in menu`
1. In the body of your PR include a more detailed summary of the changes you made and why.
5. In the body of your PR include a more detailed summary of the changes you
- If the PR is meant to fix an existing bug/issue then, at the end of your PR's description, append the keyword `closes` and #xxxx (where xxxx is the issue number).
made and why.
- Example: `closes #1337`. This tells GitHub to automatically close the existing issue, if the PR is merged.
1. Indicate if you have tested on a local copy of the site or not.
- If the PR is meant to fix an existing bug/issue then, at the end of
your PR's description, append the keyword `closes` and #xxxx (where xxxx
is the issue number). Example: `closes #1337`. This tells GitHub to
close the existing issue, if the PR is merged.
6. Indicate if you have tested on a local copy of the site or not.
### How We Review and Merge Pull Requests
### How We Review and Merge Pull Requests
rambox has a team of volunteer Issue Moderators. These Issue Moderators routinely go through open pull requests in a process called [Quality Assurance]
Rambox has a team of volunteer Issue Moderators. These Issue Moderators routinely go through open pull requests in a process called [Quality Assurance](https://en.wikipedia.org/wiki/Quality_assurance) (QA).
1. If an Issue Moderator QA's a pull request and confirms that the new code does what it is supposed without seeming to introduce any new bugs, they will comment
"LGTM" which means "Looks good to me."
1. If an Issue Moderator QA's a pull request and confirms that the new code does what it is supposed without seeming to introduce any new bugs, they will comment: `"LGTM" which means "Looks good to me."`
1. Another Issue Moderator will QA the same pull request.
- Once they have also confirmed that the new code does what it is supposed to without seeming to introduce any new bugs, they will merge the pull request.
2. Another Issue Moderator will QA the same pull request. Once they have also confirmed that the new code does what it is supposed to without seeming to introduce
If you would like to apply to join our Issue Moderator team - which is a Core Team position - message [@BerkeleyTrue](https://gitter.im/berkeleytrue) with links to 5 of your pull requests that have been accepted and 5 issues where you have helped someone else through commenting or QA'ing.
any new bugs, they will merge the pull request.
If you would like to apply to join our Issue Moderator team - which is a Core Team position - message [@BerkeleyTrue](https://gitter.im/berkeleytrue) with links
to 5 of your pull requests that have been accepted and 5 issues where you have helped someone else through commenting or QA'ing.
### How We Close Stale Issues
### How We Close Stale Issues
We will close any issues or pull requests that have been inactive for more than 15 days, except those that match the following criteria:
We will close any issues or pull requests that have been inactive for more than 15 days, except those that match the following criteria:
- bugs that are confirmed
- pull requests that are waiting on other pull requests to be merged
- Bugs that are confirmed
- features that are a part of a GitHub project
- Pull requests that are waiting on other pull requests to be merged
- Features that are a part of a GitHub project
### Next Steps
### Next Steps
@ -251,21 +221,17 @@ We will close any issues or pull requests that have been inactive for more than
Once your PR is accepted, you may delete the branch you created to submit it.
Once your PR is accepted, you may delete the branch you created to submit it.
This keeps your working fork clean.
This keeps your working fork clean.
You can do this with a press of a button on the GitHub PR interface. You can
You can do this with a press of a button on the GitHub PR interface. You can delete the local copy of the branch with: `git branch -D branch/to-delete-name`
delete the local copy of the branch with: `git branch -D branch/to-delete-name`
#### If your PR is rejected
#### If your PR is rejected
Don't despair! You should receive solid feedback as to
Don't despair! You should receive solid feedback as to why it was rejected and what changes are needed.
why it was rejected and what changes are needed.
Many Pull Requests, especially first Pull Requests, require correction or
Many Pull Requests, especially first Pull Requests, require correction or updating.
updating. If you have used the GitHub interface to create your PR, you will need
If you have used the GitHub interface to create your PR, you will need to close your PR, create a new branch, and re-submit.
to close your PR, create a new branch, and re-submit.
If you have a local copy of the repo, you can make the requested changes and
If you have a local copy of the repo, you can make the requested changes and amend your commit with: `git commit --amend` This will update your existing
amend your commit with: `git commit --amend` This will update your existing
commit.
commit. When you push it to your fork you will need to do a force push to
When you push it to your fork you will need to do a force push to overwrite your old commit: `git push --force`
overwrite your old commit: `git push --force`
Be sure to post in the PR conversation that you have made the requested changes.
Be sure to post in the PR conversation that you have made the requested changes.
<h4align="center">Free, Open Source and Cross Platform messaging and emailing app that combines common web applications into one.</h4>
<h4>Free, Open Source and Cross Platform messaging and emailing app that combines common web applications into one.</h4>
<palign="center">
<p>
<ahref="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WU75QWS7LH2CA"target="_blank"><imgsrc="https://img.shields.io/badge/Donate-PayPal-green.svg"alt="Donate with PayPal"></a>
<ahref="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WU75QWS7LH2CA"target="_blank"><imgsrc="https://img.shields.io/badge/Donate-PayPal-green.svg"alt="Donate with PayPal"/></a>
<imgwidth="80"align="left"src="https://raw.githubusercontent.com/saenzramiro/rambox/master/resources/icons/messengerpages.png"alt="Messenger for Pages"title="Messenger for Pages">
<imgwidth="80"src="./resources/icons/messengerpages.png"alt="Messenger for Pages"title="Messenger for Pages"/>
<imgwidth="80"align="left"src="https://raw.githubusercontent.com/saenzramiro/rambox/master/resources/icons/messengerpages.png"alt="Messenger for Business"title="Messenger for Business">
Sessions will persist using the [partition:persist](https://electronjs.org/docs/api/webview-tag#partition) attribute for Webviews. So every time you open Rambox, your sessions will keep alive until you remove the service.
Sessions will persist using the [partition:persist](https://electronjs.org/docs/api/webview-tag#partition) attribute for Webviews.
So every time you open Rambox, your sessions will keep alive until you remove the service.
Sync feature use Auth0 for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service). You are always welcome to check the code! ;)
Sync feature use Auth0 for Single Sign On & Token Based Authentication and to store the services that user is using (and the configuration for each service).
Jakub Čábera
7 years ago