1
0
Fork 0
mirror of https://github.com/aasm/aasm synced 2023-03-27 23:22:41 -04:00
aasm/CONTRIBUTING.md
Whatisinternet c6a4955e3d Added contributing documentation
This lowers the barrier to entry on contributing to AASM by providing a
more detailed guide on how to get the project installed for local
development.
2017-02-24 13:04:47 +05:30

1.1 KiB

Contributing

While not required to contribute, we recommend RVM to manage your rubies.

  1. Read the Contributor Code of Conduct
  2. Fork it
  3. Clone the project git clone git@github.com:[YOUR GITHUB USERNAME]/aasm.git
  4. cd aasm
  5. Create your feature branch git checkout -b my-new-feature
  6. Write tests for your changes (feature/bug)
  7. Write your (feature/bugfix)
  8. Install the dependencies appraisal install
  9. Run the tests appraisal rspec
  10. Commit your changes git commit -am 'Added some feature'
  11. Push to the branch git push origin my-new-feature
  12. Create new Pull Request

There are some option dependencies as well.

If we've missed something please open an issue