Skip to content

Latest commit

 

History

History
26 lines (15 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

26 lines (15 loc) · 1.45 KB

How to contribute

I'm really glad you're reading this, because we need volunteer developers to help this project be successful long-term.

We make a commitment to review all PRs (pull requests) that are submitted by members of the community. We will provide feedback and recommendations with the effort of incorperating contributions from the community whenever possible.

Testing

If you add a new feature or fix a bug, it's generally a good idea to write a test to accompany it! Tests help us ensure that our users can depend on Sequel Ace.

Submitting changes

Please send a GitHub Pull Request to Sequel Ace, pointed at the dev branch, with a clear list of what you've done (read more about pull requests). Please include detailed explainations of what changed (screenshots of changes are preferred). Please avoid committing changes that are unrelated to the pull request (if you accidentally edited an .xib file, it's all good, just revert changes to that unrelated file).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
> 
> A paragraph describing what changed and its impact."

Coding conventions

Start reading our code and you'll get the hang of it. We optimize for readability!

Thanks, The Sequel Ace Team