mirror of
https://github.com/mperham/sidekiq.git
synced 2022-11-09 13:52:34 -05:00
added beginner's guide to contributing and made RSS link target blank
This commit is contained in:
parent
fe07290c36
commit
2781be13ea
2 changed files with 59 additions and 1 deletions
58
.github/contributing.md
vendored
58
.github/contributing.md
vendored
|
@ -32,6 +32,64 @@ And in order to run the tests and linter checks:
|
|||
bundle exec rake
|
||||
```
|
||||
|
||||
### Beginner's Guide to Local Development Setup
|
||||
|
||||
#### 1. Fork [mperham/sidekiq](https://github.com/mperham/sidekiq) project repository to your personal GitHub account
|
||||
|
||||
#### 2. Click 'Clone or Download' button in personal sidekiq repository and copy HTTPS URL
|
||||
|
||||
#### 3. On local machine, clone repository
|
||||
|
||||
```
|
||||
git clone HTTPS-URL-FOR-PERSONAL-SIDEKIQ-REPOSITORY
|
||||
```
|
||||
|
||||
#### 4. Navigate to your local machine's sidekiq directory
|
||||
|
||||
```
|
||||
cd sidekiq/
|
||||
```
|
||||
|
||||
#### 5. Set remote upstream branch
|
||||
|
||||
```
|
||||
git remote add upstream https://github.com/mperham/sidekiq.git
|
||||
```
|
||||
|
||||
#### 6. Install necessary gems for development and start Redis server
|
||||
|
||||
```
|
||||
bundle install
|
||||
```
|
||||
|
||||
```
|
||||
redis-server
|
||||
```
|
||||
|
||||
#### 7. Navivate to myapp (small Rails app inside Sidekiq repository used for development)
|
||||
|
||||
```
|
||||
cd myapp/
|
||||
```
|
||||
|
||||
#### 8. Run required migration in order to launch Rails app
|
||||
|
||||
```
|
||||
rake db:migrate
|
||||
```
|
||||
|
||||
#### 9. Launch Rails app
|
||||
|
||||
```
|
||||
rails s
|
||||
```
|
||||
|
||||
#### 10. Create feature branch and start contributing!
|
||||
|
||||
```
|
||||
git checkout -b new_feature_name
|
||||
```
|
||||
|
||||
## Legal
|
||||
|
||||
By submitting a Pull Request, you disavow any rights or claims to any changes
|
||||
|
|
|
@ -48,7 +48,7 @@
|
|||
<thead>
|
||||
<th><%= t('Name') %></th>
|
||||
<th><%= t('Started') %></th>
|
||||
<th class="col-sm-1"><%= t('RSS') %><a href="https://github.com/mperham/sidekiq/wiki/Memory#rss"><span class="info-circle" title="Click to learn more about RSS">?</span></a></th>
|
||||
<th class="col-sm-1"><%= t('RSS') %><a target="blank" href="https://github.com/mperham/sidekiq/wiki/Memory#rss"><span class="info-circle" title="Click to learn more about RSS">?</span></a></th>
|
||||
<th class="col-sm-1"><%= t('Threads') %></th>
|
||||
<th class="col-sm-1"><%= t('Busy') %></th>
|
||||
<th> </th>
|
||||
|
|
Loading…
Add table
Reference in a new issue