Skip to content

Commit

Permalink
Add CONTRIBUTING (#78)
Browse files Browse the repository at this point in the history
  • Loading branch information
nickcharlton authored Jan 25, 2024
1 parent bcf4c74 commit 194e887
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing Guide

## Code of Conduct

We welcome pull requests from everyone. By participating in this project, you
agree to abide by the thoughtbot [code of conduct].

We expect everyone to follow the code of conduct anywhere in thoughtbot's
project codebases, issue trackers, chat-rooms, and mailing lists.

[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct

## Getting Started

`administrate-field-nested_has_many` is a field plugin for [Administrate][],
that allows for nested `has_many` forms.

To maintain compatibility with different dependency versions, we use
[Appraisal][].

[Administrate]: https://github.com/thoughtbot/administrate
[Appraisal]: https://github.com/thoughtbot/appraisal

### Opening a PR

1. Fork the repo,
2. Run `./bin/setup` to install the base dependencies and setup a local
database,
3. Run the test suite: `bundle exec rspec && bundle exec appraisal rspec`,
4. Make your changes,
5. Push your fork and open a pull request.

A good PR will solve the smallest problem it possibly can, have good test
coverage and (where necessary) have internationalisation support.

## Security

See the [security policy](./SECURITY.md).

0 comments on commit 194e887

Please sign in to comment.