This is the development repository for Bike!Bike! Progress can currently be seen at [preview.bikebike.org](https://preview-en.bikebike.org/) and in production at [bikebike.org](https://bikebike.org/)
| Environment | Build Status |
| ----------- |:------------:|
| Development | [](https://travis-ci.org/bikebike/BikeBike) |
| Production | [](https://travis-ci.org/bikebike/BikeBike) |
If you're about to get started contributing please contact Godwin: `goodgodwin``@``hotmail.com`. Also try to familiarize yourself with the [technologies](#technologies) we're using, our [collaboration tools](#collaboration-tools), [requirements](#requirements-overview), [coding conventions](#coding-conventions), [style guide](#style-guide), and [testing practices](#testing-practices).
This is the repository for the Bike!Bike! website. It can be found in development at [preview.bikebike.org](https://preview-en.bikebike.org/) and in production at [bikebike.org](https://bikebike.org/)
### Technologies ###
Feel free to clone or fork the repository any time to start working on new features or fixes. To get help create an issue or contact Godwin: `goodgodwin``@``hotmail.com` any time.
* [Ruby 2.0.0][1]
## Technologies ##
* [Rails 4.0.0][2]
* [Ruby 2.3.0][1]
* [Rails 4.2.0][2]
* [PostgreSQL][3]
* [PostgreSQL][3]
* [HAML][4]
* [HAML][4]
* [SCSS][5]
* [SCSS][5]
@ -33,33 +37,24 @@ Here is a list of the gems we have created so far, if you are a collaborator on
[Bumbleberry](https://github.com/bumbleberry/bumbleberry) provides cross-browser support with little effort and minimum file sizes. Basically it creates a different stylesheet for every known browser and only includes supported rules for each using information obtained from [caniuse.com](caniuse.com).
[Bumbleberry](https://github.com/bumbleberry/bumbleberry) provides cross-browser support with little effort and minimum file sizes. Basically it creates a different stylesheet for every known browser and only includes supported rules for each using information obtained from [caniuse.com](caniuse.com).
## Collaboration Tools ##
* [Trello][6]
* [GitHub][7]
* [Google Hangouts][8]
[6]: https://trello.com/b/X4TGKQ1L/rails-tasks
[7]: https://github.com/bikebike/BikeBike
[8]: http://www.google.com/+/learnmore/hangouts/
## Github Workflow ##
## Github Workflow ##
If you are a git wiz, feel free to adjust the steps below slightly, otherwise follow these steps until you are familiar enough to stray. What should remain constant is that we need to branch, code review, and merge with master.
If you are a git wiz, feel free to adjust the steps below slightly, otherwise follow these steps until you are familiar enough to stray. What should remain constant is that we need to branch, code review, and merge with master.
1. Before you start working on a new feature, start working on a new branch (alternatively you can fork): `git checkout -b myname_new_feature`
1. Before you start working on a new feature, start working on a new branch (alternatively you can fork): `git checkout -b myname_new_feature`
2. Write your new feature
1. Write your new feature
3. Add tests and execute them using `bundle exec rake cucumber`
1. Add tests and execute them using `bundle exec i18n`
4. Make any adjustments, make sure you have included comments and abided other coding conventions
1. Make any adjustments, make sure you have included comments and abided other coding conventions
5. Check your git status to make sure you are on the correct branch and have any new files to add: `git status`
1. Check your git status to make sure you are on the correct branch and have any new files to add: `git status`
6. Add any new files using: `git add [myfile]`
1. Add any new files using: `git add [myfile]`
7. Commit your changes: `git commit -am 'My commit message'`
1. Commit your changes: `git commit -am 'My commit message'`
8. Switch back to the master branch and pull the latest: `git checkout master && git pull`
1. Switch back to the development branch and pull the latest: `git checkout master && git pull`
9. Switch back to your branch: `git checkout myname_new_feature`
1. Switch back to your branch: `git checkout myname_new_feature`
10. If there were any changes, rebase (if in doubt, rebase). This merges in the new code with your new code: `git rebase -i origin/master`
1. If there were any changes, rebase. This merges in the new code with your new code: `git rebase -i origin/development`
11. Push your changes: `git push origin myname_new_feature`
1. Push your changes: `git push origin myname_new_feature`
12. Make a pull request and wait for your code to be reviewed
1. Make a pull request and wait for your code to be reviewed
13. If any changes are required, make them commit your changes, and rebase again. This time you need to make sure that you squash your commits (makes sure you only add one commit in the end). Where you see your commit message, change 'pick' to 'fixup' or 'f'.
1. If any changes are required, make them commit your changes, and rebase again. This time you need to make sure that you squash your commits (makes sure you only add one commit in the end). Where you see your commit message, change 'pick' to 'fixup' or 'f'.
14. Push your code again and repeat 12 and 13 until your code gets merged with master
1. Push your code again and repeat 12 and 13 until your code gets merged with development
1. Once your code is in development it will be released to our development site, once new translations are added and the site is manually tested it will be moved to master and the production site
## Deployment Process ##
## Deployment Process ##
Please note, we currently don't have this process set up, we're working to get here.
Please note, we currently don't have this process set up, we're working to get here.
@ -70,52 +65,8 @@ Please note, we currently don't have this process set up, we're working to get h
4. Once that deployment process completes and tests pass, translators will be notified if there are new translations
4. Once that deployment process completes and tests pass, translators will be notified if there are new translations
4. Once translators have completed translations, translations will be committed to master and your changes will be deployed to production
4. Once translators have completed translations, translations will be committed to master and your changes will be deployed to production
## Requirements Overview ##
Bike!Bike! is a conference which is held in and hosted by a different city each year. The conference is specifically for not for profit bicycle collectives (5013c or equivalent status is not required). There are also 'Reginal Bike!Bike!s' which can be hosted by any organization at any time of the year.
The Bike!Bike! website will help coordinate these conferences, allowing users to register, to create organizations, and organize conferences.
### Users ###
Users should be able to register and log in, either with our system or using Facebook. We will store user name, encrypted passwords, email addresses, avatars, and user settings.
### Organizations ###
An organization can be created by any user. An organization has a name, location, logo, email address, and some additional optional settings. An organization also contains a list of users which can interact and represent the organization on the site. A user is added to the organization by either:
1. Creating the organization
2. Requesting membership
3. Being invited by an existing member
Organizations can be set up to allow anyone to become a member, require verification, require a secret password, or only allow invitations.
### Conferences ###
Conferences can be created by any user who is associated with an organization. A conference has a name, date, location, a list of host organizations, and optional administrators.
A conference can be modified by anyone who has been added as an administrator directly, or is a member of any of the host organizations.
### Registration ###
Any member of the site can register for a conference. A form must be constructed by the conference corrdinators and must then be completed by the registrant.
### Workshops ###
## Translations ##
Any user who is register for a specific conference can propose workshops for that conference. A workshop is later scheduled by the conference coordinators if they decide to include it in the conference. A workshop can have one or more facilitators which are added in a similar process as users are added to an organization.
### Events ###
Events are created and scheduled by conference coordinators.
## Coding Conventions ##
### Ruby ###
### CoffeeScript ###
### Haml ###
### SCSS ###
### Translations ###
Translating our site into multiple languages is a key part of opening it up to the world. When coding, never include any English text as in a string or Haml. Instead, we shall always use the underscore helper method `_`. The method takes a translation key and some optional parameters.
Translating our site into multiple languages is a key part of opening it up to the world. When coding, never include any English text as in a string or Haml. Instead, we shall always use the underscore helper method `_`. The method takes a translation key and some optional parameters.
@ -142,16 +93,22 @@ If the user has sufficient rights, these blocks will also be surrounded by the n
Translations are recorded during testing and committed to the repository when pushing to github. After pulling down the latest version from github you should always run `rake translations:migrate` to put the latest migrations into your database.
Translations are recorded during testing and committed to the repository when pushing to github. After pulling down the latest version from github you should always run `rake translations:migrate` to put the latest migrations into your database.
### Style Guide ###
## Testing Practices ##
On hold until our design team determines a director for our identity.
Our focus will be on integration testing using Capybara. While testing the app records all translations that it finds, whether or not they exist, and which pages that they were found on.
Before commiting you shuold always run:
## Testing Practices ##
```bash
bundle exec cucumber
```
Our focus will be on integration testing using Capybara. While testing the app records all translations that it finds, whether or not they exist, and which pages that they were found on.
and:
## Attribution ##
```bash
bundle exec rake i18n
```
### Icons ###
The former is going to be faster but does not perform checks for untranslated content, it is recommneded that you run this regularily while developing while running the `i18n` check will ensure that you have not missed translations.
If you are creating any new content you will also want to add a new feature or scenario to ensure the new translations are picked up.
Godwin
8 years ago
GitHub