Pull requests are welcome from anyone, please feel free to contribute by following the below guidelines.
Fork, then clone the repo:
git clone git@github.com:your-username/publishers.git
Write your code and tests, then make sure the tests pass:
bin/rake test
Push to your fork and submit a pull request.
We like to make sure that all contributions follow a few guidelines, which will increase the likelihood of a merge:
- Follow the code review guildelines
- Write tests to cover critical functionality
- Write a good commit message
- Leave code better than you found it, whenever possible:
- eliminate callbacks, use a service object instead
- use dependency injection to encourage modularity, an example
- follow Sandi Metz' rules
- prefer composition over inheritance
If your code touches any of the aspects mentioned here, or more specific to creators:
- Any changes to data being sent in the pCDN
- Any changes in data being sent from Eyeshade
- Any information collection changes for registration
- Email auth flow changes
- oAuth flow changes
Please open a security review