Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 2.53 KB

contributing.md

File metadata and controls

41 lines (28 loc) · 2.53 KB

Contributing

Hi! Let's innovate together! We are enthusiastic that you'd like to contribute to our projects. Together we build the future of finance and IT.

Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributing tips

Make sure your idea is unique

Before doing anything, do a quick check to make sure your idea hasn't been discussed elsewhere. Skim the project's README, issues (open and closed), mailing list, and Stack Overflow. You don't have to spend hours going through everything, but a quick search for a few key terms goes a long way.

If you can't find your idea elsewhere, you're ready to make a move.

Respect community decisions.

Your ideas may differ from the community's priorities or vision. The community may offer feedback or decide not to pursue your idea. While you should discuss and look for compromise, maintainers have to live with your decision longer than you do. If you disagree with their direction, you can always work on your own fork or start your own project.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow standards for style and code quality
  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Submitting a pull request

  1. Fork and clone the repository. For detailed instructions see Cloning a repository.
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change.
  4. Add tests and make sure the tests pass successfully.
  5. Push changes to your branch and submit a pull request.
  6. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Resources