Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.72 KB
Raw

Contributing to Football League Standings Backend Server

First off, thank you for considering contributing to the Football League Fixtures Backend Server. It's people like you that make it a great tool.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include snippets of code or screenshots if you think they will help.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

  • Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most Football League Standings Backend Server users.

Your First Code Contribution

Unsure where to begin contributing to Football League Standings Backend Server? You can start by looking through 'beginner' and 'help-wanted' issues:

  • Beginner issues - issues that should only require a few lines of code, and a test or two.
  • Help wanted issues - issues that may need a bit more effort or knowledge about the project.

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the Node.js coding style guide
  • Document new code based on the project's code documentation style
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

License

By contributing to Football League Standings Backend Server, you agree that your contributions will be licensed under its MIT License.