CONTRIBUTING.md

How to contribute

So you want to make Speakerinnen Liste better. Great!

Here are the steps to contribute:

Grab an issue

Here, you'll have an overview over the open issues: rubymonsters#216. We are happy to answer your questions if you consider to help. All the issues have a link to their specification. If you want to work on an issue feel free to assign yourself.

If you have other ideas feel free to open an own issue!

Working on your own branch

1. Fork the main repository. This is your own copy of the speakerinnen_liste project to work in.
2. Clone your repository to your local machine.
3. git checkout -b newdesign This creates a new branch, called newdesign in our example, in your local repository.
4. Make your changes.
5. git commit
6. git push origin newdesign:newdesign This pushes your new branch called newdesign to your GitHub repository.

Integrating your working code to master

When you have made your changes and tested them, please send us a pull request.

Before you start working

1. For your database.yml please copy config/database_example.yml (Example below in Mac OS X or Linux):

   cp config/database_example.yml config/database.yml
   

2. Install PostgreSQL (it depends on your OS)

3. Create a PostgreSQL user with the same name as your username

4. Install Bundler (if you don't have it already)

   gem install bundler
   

5. Install gems:

   bundle install
   

6. Create the database:

   bundle exec rake db:create
   

7. Run the database migrations:

   bundle exec rake db:migrate
   

8. Run the database seeds:

   bundle exec rake db:seed
   

9. Run the app:

   bundle exec rails s
   

10. If you build or test some admin features you have to create an admin user. You also can assign the status via the console:

    rails c
    user = Profile.find(<your-profile-id>)
    user.admin = true
    user.save
    

Git(Hub) Help

If you have any questions about Git or GitHub, GitHub Help is a great resource!