Class: Osrcry::Contributing

Inherits:
Object
  • Object
show all
Defined in:
lib/osrcry/contributing.rb

Class Method Summary collapse

Class Method Details

.executeObject



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# File 'lib/osrcry/contributing.rb', line 3

def self.execute

  contributing = <<-CONTRIBUTING
## Getting Involved

New contributors are always welcome, when it doubt please ask questions. We strive to be an open and welcoming community. Please be nice to one another.

### Coding

* Pick a task:
  * Offer feedback on open [pull requests](https://github.com/#{Osrcry.user}/#{Osrcry.repo}/pulls).
  * Review open [issues](https://github.com/#{Osrcry.user}/#{Osrcry.repo}/issues) for things to help on.
  * [Create an issue](https://github.com/#{Osrcry.user}/#{Osrcry.repo}/issues/new) to start a discussion on additions or features.
* Fork the project, add your changes and tests to cover them in a topic branch.
* Commit your changes and rebase against `#{Osrcry.user}/#{Osrcry.repo}` to ensure everything is up to date.
* [Submit a pull request](https://github.com/#{Osrcry.user}/#{Osrcry.repo}/compare/).

### Non-Coding

* Offer feedback on open [issues](https://github.com/#{Osrcry.user}/#{Osrcry.repo}/issues).
* Organize or volunteer at events.
CONTRIBUTING

  File.open('CONTRIBUTING.md', 'w') do |file|
    file.write(contributing)
  end
end