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
Showing
2,409 changed files
with
389,651 additions
and
64,461 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
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
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 |
---|---|---|
@@ -1,14 +1,15 @@ | ||
language: ruby | ||
bundler_args: --full-index --without development | ||
bundler_args: "--full-index --without development" | ||
cache: bundler | ||
rvm: | ||
- 2.2.3 | ||
env: | ||
- TEST_LOCALE=fra | ||
- TEST_LOCALE=eng | ||
- 2.2.7 | ||
before_install: test/ci/before_install | ||
before_script: test/ci/before_script | ||
script: xvfb-run bundle exec rake test:run_all DRIVER=webkit LOCALE=$TEST_LOCALE | ||
# script: bundle exec rake test:core | ||
before_script: test/ci/before_script | ||
script: xvfb-run bundle exec rake test:models test:libs test:controllers DRIVER=webkit | ||
services: | ||
- redis-server | ||
- redis-server | ||
notifications: | ||
webhooks: https://coveralls.io/webhook?repo_token=COVERALLS_REPO_TOKEN | ||
email: false | ||
slack: | ||
secure: v1/ya/fyroy3BmW9FDMmKi3lwamnzY6ktQAU/vEJCg4AgvauY0QJthMsLXOBb3RnhFWao2Kj2H40XjI7VtH3z46VEq6DPLURBqmAc24c30ZMi/XIM9YqauYeEPHPhM0nDQY+s0ovU2uX/1w7uv/atNjy0n643An61Em+qPwIW5U= |
Large diffs are not rendered by default.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,146 @@ | ||
## Contributing | ||
|
||
First off, thank you for considering contributing to Ekylibre. It's people | ||
like you that make Ekylibre such a great tool. | ||
|
||
### 1. Where do I go from here? | ||
|
||
If you've noticed a bug or have a question, | ||
[search the issue tracker](https://github.com/ekylibre/ekylibre/issues?q=something) | ||
to see if someone else in the community has already created a ticket. | ||
If not, go ahead and [make one](https://github.com/ekylibre/ekylibre/issues/new)! | ||
|
||
### 2. Fork & create a branch | ||
|
||
If this is something you think you can fix, then | ||
[fork Ekylibre](https://help.github.com/articles/fork-a-repo) | ||
and create a branch with a descriptive name. | ||
|
||
A good branch name would be (where issue #1747 is the ticket you're working on): | ||
|
||
```sh | ||
git checkout -b 1747-add-rapeseed-varieties | ||
``` | ||
|
||
### 3. Get the test suite running | ||
|
||
Make sure you're using a recent ruby and have the `bundler` gem installed, at | ||
least version `1.14.6`. The most reliable `bundler` version to use is the same | ||
Travis is using. | ||
|
||
Install the development dependencies: | ||
|
||
```sh | ||
bundle install | ||
``` | ||
|
||
Now you should be able to run the entire suite using: | ||
|
||
```sh | ||
bundle exec rake test | ||
``` | ||
#### 4. Did you find a bug? | ||
|
||
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/ekylibre/ekylibre/issues). | ||
|
||
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/aekylibre/ekylibre/issues/new). | ||
Be sure to include a **title and clear description**, as much relevant information as possible, | ||
and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. | ||
|
||
* If possible, use the relevant bug report templates to create the issue. | ||
Simply copy the content of the appropriate template into a .rb file, make the necessary changes to demonstrate the issue, | ||
and **paste the content into the issue description**: | ||
* [**Rails 5** issues](https://github.com/ekylibre/ekylibre/blob/master/lib/bug_report_templates/rails_5_master.rb) | ||
|
||
### 5. Implement your fix or feature | ||
|
||
At this point, you're ready to make your changes! Feel free to ask for help; | ||
everyone is a beginner at first :smile_cat: | ||
|
||
### 6. View your changes in a Rails application | ||
|
||
Ekylibre is meant to be used by humans, not cucumbers. So make sure to take | ||
a look at your changes in a browser. | ||
|
||
To initialize a default farm: | ||
|
||
```sh | ||
bundle exec rake tenant:init TENANT=sample | ||
``` | ||
|
||
This will automatically create a empty tenant with a default account. | ||
|
||
Then to boot up app: | ||
|
||
```sh | ||
bundle exec foreman start TENANT=sample | ||
``` | ||
You should now be able to open <http://localhost:8080/> in your browser. | ||
You can log in using: | ||
|
||
``` | ||
User: admin@ekylibre.org | ||
``` | ||
|
||
If you need to migrate the database: | ||
|
||
```sh | ||
bundle exec rake local db:migrate | ||
``` | ||
|
||
### 7. Make a Pull Request | ||
|
||
At this point, you should switch back to your master branch and make sure it's | ||
up to date with Ekylibre's master branch: | ||
|
||
```sh | ||
git remote add upstream git@github.com:ekylibre/ekylibre.git | ||
git checkout master | ||
git pull upstream master | ||
``` | ||
|
||
Then update your feature branch from your local copy of master, and push it! | ||
|
||
```sh | ||
git checkout 1747-add-rapeseed-varieties | ||
git rebase master | ||
git push --set-upstream origin 1747-add-rapeseed-varieties | ||
``` | ||
|
||
Finally, go to GitHub and | ||
[make a Pull Request](https://help.github.com/articles/creating-a-pull-request) | ||
:D | ||
|
||
### 8. Keeping your Pull Request updated | ||
|
||
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code | ||
has changed, and that you need to update your branch so it's easier to merge. | ||
|
||
To learn more about rebasing in Git, there are a lot of | ||
[good](http://git-scm.com/book/en/Git-Branching-Rebasing) | ||
[resources](https://help.github.com/articles/interactive-rebase), | ||
but here's the suggested workflow: | ||
|
||
```sh | ||
git checkout 1747-add-rapeseed-varieties | ||
git pull --rebase upstream master | ||
git push --force-with-lease 1747-add-rapeseed-varieties | ||
``` | ||
|
||
### 9. Merging a PR (maintainers only) | ||
|
||
A PR can only be merged into master by a maintainer if: | ||
|
||
* It is passing CI. | ||
* It has been approved by at least two maintainers. If it was a maintainer who | ||
opened the PR, only one extra approval is needed. | ||
* It has no requested changes. | ||
* It is up to date with current master. | ||
|
||
Any maintainer is allowed to merge a PR if all of these conditions are | ||
met. | ||
|
||
|
||
### Thanks | ||
|
||
Thanks to Active Admin. This document is largely inspirated from their own. |
Oops, something went wrong.