mirror of
https://github.com/aasm/aasm
synced 2023-03-27 23:22:41 -04:00
c6a4955e3d
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.
1.1 KiB
1.1 KiB
Contributing
While not required to contribute, we recommend RVM to manage your rubies.
- Read the Contributor Code of Conduct
- Fork it
- Clone the project
git clone git@github.com:[YOUR GITHUB USERNAME]/aasm.git
cd aasm
- Create your feature branch
git checkout -b my-new-feature
- Write tests for your changes (feature/bug)
- Write your (feature/bugfix)
- Install the dependencies
appraisal install
- Run the tests
appraisal rspec
- Commit your changes
git commit -am 'Added some feature'
- Push to the branch
git push origin my-new-feature
- Create new Pull Request
There are some option dependencies as well.
If we've missed something please open an issue