Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated Workflow and Style Guidelines

...

That said, all of our publicly-available code on GitHub is licensed under very permissive licenses that permit you to run with it and use it for your purposes. Be our guest! It's just a question of whether we can accept contributions that are merged back into our repositories, and whether we are able to put energy towards code reviews and evaluation of new pull requests; and also whether you want to use some of this older code that does not represent where we're headed these days with our current efforts.

Workflow and Style guidelines

Please observe the following guidelines:

  • Read about our Branching and Release Model. You need to be able to determine if our repository uses GitFlow or OneFlow.
  • Write tests for your contributions.
  • Document methods you add using doc comments.
  • Follow the included style guidelines.
  • Use well-formed commit messages. Highlights from the aforementioned resource:
    • Use the imperative voice
    • Limit subject line width to 50 characters ideally, 72 characters maximum
    • Explain what and why
  • Fork our repository, create a topic branch, and submit a GitHub pull request targeting either the master or develop branch of our repository, depending on whether our repository uses GitFlow or OneFlow.

...