Skip to content

Latest commit

 

History

History
175 lines (120 loc) · 8.82 KB

CONTRIBUTING.md

File metadata and controls

175 lines (120 loc) · 8.82 KB

Contributing

✨ Thanks for contributing to Steam Stats! ✨

As a contributor, here are the guidelines I would like you to follow:

Contributing to Steam Stats

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.

Code of conduct

Help me keep steam-stats open and inclusive. Please read and follow the Code of conduct.

How can I contribute?

Improve documentation

As a Steam Stats user, you are the perfect candidate to help me improve the documentation: typo corrections, clarifications, more examples, etc. Take a look at the documentation issues that need help.

Please follow the Documentation guidelines.

Give feedback on issues

Some issues are created without the information requested in the Bug report guideline. Help make them easier to resolve by adding any relevant information.

Issues with the enhancement label are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence the future direction of Steam Stats.

Fix bugs and implement features

Confirmed bugs and ready-to-implement features can be marked with the help wanted label. Post a comment on an issue to indicate you would like to work on it and to request help from the me and the community.

Using the issue tracker

The issue tracker is the channel for bug reports, features requests, submitting pull requests and many more.

Before opening an issue or a Pull Request, please use the GitHub issue search to make sure the bug or feature request hasn't been already reported or fixed.

Bug report

A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the bug report template.

Feature request

Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aim of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and fill the information requested in the feature request template.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: pip install
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your change, add tests, and make sure the tests still pass
  5. Push to your fork and submit a pull request
  6. Pat your self on the back and wait for your pull request to be reviewed and merged.

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

  • Follow the guide.
  • 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.
  • While doing the commits, please strictly follow conventional commits.

Coding rules

Source code

To ensure consistency and quality throughout the source code, all code modifications must have:

  • No linting errors
  • A test for every possible case introduced by your code change
  • 100% test coverage
  • Valid commit message(s)
  • Documentation for new features
  • Updated documentation for modified features

Documentation

To ensure consistency and quality, all documentation modifications must:

  • Refer to brand in bold with proper capitalization, i.e. GitHub, Steam-Stats,etc.
  • Prefer tables over lists when listing key values, i.e. List of options with their description
  • Use links when you are referring to:
    • A Steam-Stats concept described somewhere else in the documentation, i.e. How to contribute
    • A third-party product/brand/service, i.e. Integrate with GitHub
    • An external concept or feature, i.e. Create a GitHub release
  • Use the single backtick code quoting for:
    • programming language keywords, i.e. function, async, String
  • Use the triple backtick code formatting for:
    • code examples
    • configuration examples
    • sequence of command lines

Commit message guidelines

Atomic commits

If possible, make atomic commits, which means:

  • a commit should contain exactly one self-contained functional change
  • a functional change should be contained in exactly one commit
  • a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature without documentation, etc...)

A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.

Commit message format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

The footer can contain a closing reference to an issue.

Please check COMMITS.md for a detailed explanation about the commit message format and conventional commits.

Lint

Pylint

Steam Stats repository uses autopep8 and Pylint for formatting and linting.

autopep8 automatically formats Python code to conform to the PEP 8 style guide.

Other Lint Tools

Other tools are used for specific compatibility concerns, but are less likely to result in failures in common contributions. Please follow the guidance of these tools if failures are encountered.

Resources