Skip to content

Latest commit

 

History

History
146 lines (101 loc) · 4.31 KB

CONTRIBUTING.md

File metadata and controls

146 lines (101 loc) · 4.31 KB
Raw

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 to see if someone else in the community has already created a ticket. If not, go ahead and make one!

2. Fork & create a branch

If this is something you think you can fix, then fork Ekylibre and create a branch with a descriptive name.

A good branch name would be (where issue #1747 is the ticket you're working on):

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:

bundle install

Now you should be able to run the entire suite using:

bundle exec rake test

4. Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. 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:

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 😸

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:

bundle exec rake tenant:init TENANT=sample

This will automatically create a empty tenant with a default account.

Then to boot up app:

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:

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:

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!

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 :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 resources, but here's the suggested workflow:

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.