Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

28 lines (16 loc) · 1.51 KB

Contribution Guidelines

Please read our Code of Conduct first, any changes that do not follow the Code of Conduct will not be considered for inclusion in Data Concierge!

Commit messages

Please make sure your commit messages convey which files or features have been modified while remaining concise. The user can view commit details to see exactly which changes were made, so it only needs to be a short overview to provide at-a-glance identification.

Additionally, the imperative style should be used. Rather than added X, modified Y, say add X, modify Y. A good way to remember this is "If applied, my commit will…"

Don't do this

  • changes
  • stuff
  • added Contributions file
  • add CONTRIBUTIONS.md which contains the Contribution Guidelines for Data Concierge. The file contains a link to the Code of Conduct, guidelines about commit messages with examples of what not to do and what to do. Furthermore it explains that members of the public wishing to contribute changes to the project should submit a Pull Request

Do this

  • add Contribution Guidelines file

Coding style

We will be implementing the PEP 8 style guide in this repo. Some existing files may not have yet been formatted correctly, but please adopt the PEP 8 style for all new commits.

Pull Requests

Once you're happy with your changes, please submit a Pull Request and we will review your contribution and accept it if it matches our guidelines and the goals of the project.