Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 2.59 KB
Raw

Contributing to Olympic-Games

We're excited that you're considering contributing to Olympic Games! 
Before submitting your contribution, please read this guide to understand how you can get involved in the project.

Olympic Games is looking for contributors for all types of tasks: improvements, bug fixes, new features.

Table of contents

  • How to contribute ?
  • Reporting Bugs
  • Enhancements or new features
  • Submitting Pull Requests

How to contribute ?

  • Each issue is categorized, we ask that a first contribution must be of the “good first issue” type.
  • A contributor must fork the source project and then can submit these contributions via pull requests.
  • Pull requests will then be reviewed and processed. The associated issue will be updated accordingly.
  • Comments must contain the issue number.

Reporting Bugs

First of all, we recommend consulting the list of issues

If you find a bug in the project, please follow these steps to report the issue:

  1. First, check the existing issues to make sure the bug hasn't already been reported.
  2. If you don't find an existing report, open a new issues providing a detailed description of the encountered bug, along with steps to reproduce it.

Enhancements or new features

We also welcome suggestions for enhancements and new features. Before submitting your proposal, as for Bug reporting, please:

  1. Check the to see if someone has already proposed the same feature or a similar idea.
  2. Open a new issue describing your proposal in detail. Please include any relevant information, such as the justification for the feature, use cases, etc.

Submitting Pull Requests

If you'd like to contribute directly to the source code of Olympic Games, please follow these steps:

  1. Fork the repository and clone your fork locally.
  2. Create a new branch for your changes:

git checkout -b my-branch-name 3. Make your changes and be sure to test your code. 4. Commit your changes with a descriptive message:

git commit -am 'Add feature XYZ' 5. Push your changes to your fork:

git push origin my-branch-name 6. Open a new Pull Request providing a detailed description of your modifications and referencing any relevant issues.

The Olympic Games team will review your Pull Request as soon as possible. Thanks for your contribution!

forthebadge