-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9f3b23e
commit 02dc233
Showing
2 changed files
with
37 additions
and
26 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 |
---|---|---|
|
@@ -15,25 +15,26 @@ First ensure set up your development environment following these steps: | |
1. installing elixir [install elixir](https://elixir-lang.org/install.html). | ||
|
||
## General Steps | ||
|
||
To get involved please follow these steps: | ||
|
||
#### 1. Get the system working on your development environment by running: | ||
### 1. Get the system working on your development environment by running | ||
|
||
1. `mix deps.get` to install depedencies | ||
1. `mix deps.get` to install dependencies | ||
|
||
2. `mix test` this should be green to ensure everything is working properly | ||
|
||
#### 2. Cloning the application | ||
Fork the application from [toolshed](https://github.com/fhunleth/toolshed).Then clone your forked repository. | ||
### 2. Cloning the application | ||
|
||
#### 3. Look at what needs to be done on: | ||
Fork the application from [toolshed](https://github.com/elixir-toolshed/toolshed).Then clone your forked repository. | ||
|
||
* [New issues](https://github.com/fhunleth/toolshed/issues) column - feel free to start work | ||
### 3. Look at what needs to be done on: | ||
|
||
* review [open PRs](https://github.com/fhunleth/toolshed/pulls) on GitHub - leave comments or collaborate if interested. | ||
* [New issues](https://github.com/elixir-toolshed/toolshed/issues) column - feel free to start work | ||
|
||
* Review [open PRs](https://github.com/elixir-toolshed/toolshed/pulls) on GitHub - leave comments or collaborate if interested. | ||
|
||
## GitHub and git | ||
## GitHub and git | ||
|
||
Our **default working branch is `main`**. We do work by creating branches off `main` for new features and bugfixes. | ||
|
||
|
@@ -45,61 +46,67 @@ You should work with a fork that is: | |
|
||
clone from your forked repository like so: | ||
|
||
```git clone https://github.com/your_username/toolshed.git``` | ||
```bash | ||
git clone https://github.com/your_username/toolshed.git | ||
``` | ||
|
||
or | ||
```git clone [email protected]:your_username/toolshed.git`` | ||
|
||
Ensure you have two remotes that is `upstream` for the main repo and `origin`for your forked repo(you can name the way you wish) like so: | ||
```bash | ||
git clone [email protected]:your_username/toolshed.git | ||
``` | ||
|
||
Ensure you have two remotes that is `upstream` for the main repo and `origin`for your forked repo(you can name the way you wish) like so: | ||
|
||
```bash | ||
git remote add upstream [email protected]:fhunleth/toolshed.git | ||
git remote add upstream [email protected]:elixir-toolshed/toolshed.git | ||
``` | ||
|
||
or | ||
|
||
```bash | ||
git remote add upstream https://github.com/fhunleth/toolshed.git | ||
git remote add upstream https://github.com/elixir-toolshed/toolshed.git | ||
``` | ||
|
||
You can check that you have the two remotes like so: | ||
|
||
```bash | ||
git remote -v | ||
``` | ||
|
||
Before starting work on a new feature or bugfix, please ensure you have [synced your fork to upstream/main](https://help.github.com/articles/syncing-a-fork/): | ||
|
||
Before starting work on a new feature or bugfix, please ensure you have [synced your fork to upstream/develop](https://help.github.com/articles/syncing-a-fork/): | ||
|
||
``` | ||
git pull upstream main | ||
```bash | ||
git pull upstream main | ||
``` | ||
|
||
Note that you should be re-syncing as frequently as possible on your | ||
feature/bugfix branch to ensure that you are always building on top of very latest main code. | ||
|
||
### Pull Requests, committing and branch naming | ||
|
||
|
||
When creating a branch, ensure it has an issue number, this number should the issue id assigned to the issue you are working on | ||
|
||
``` | ||
git checkout -b 58-add-contributing_md | ||
```bash | ||
git checkout -b 53-add-contributing_md | ||
``` | ||
|
||
Please ensure that each commit in your pull request makes a single coherent change and that the overall pull request only includes commits related to the specific GitHub issue that the pull request is addressing. This helps the project managers understand the PRs and merge them more quickly. | ||
|
||
``` | ||
```bash | ||
This add contribution.md to the project | ||
fixes #58 | ||
fixes #53 | ||
``` | ||
|
||
Your PR can either be a draft or Ready for review. | ||
Your PR can either be a [draft](https://github.blog/2019-02-14-introducing-draft-pull-requests/) or [Ready for Review](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request). | ||
Draft means you still work in progress and do not require merging. In other words, it can be reviewed to offer assistance or suggestion but not merged | ||
|
||
Ready for Review means the PR should be reviewed with intent of merging therefore if finally approved by project manager it will be merged. | ||
|
||
Pull Request Review | ||
------------------- | ||
#### Pull Request Review | ||
|
||
Currently [Frank](https://github.com/fhunleth) is project managing toolshed. He will review your pull request as soon as possible | ||
|
||
The project manager will review the pull request for coherence with the specified feature or bug fix, and give feedback on code quality, user experience, documentation and git style. Please respond to comments from the project managers with explanation, or further commits to your pull request in order to get merged in as quickly as possible. | ||
|
||
|
||
If your tests are passing locally, but failing on CI, please have a look at the fails and if you can't fix, please do reach out to the project manager. |
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