Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

88 lines (58 loc) · 4.51 KB

Contributing to BurnOut 2.0!!

Hello!👋

Firstly, thank you so much for showing interest in BurnOut 2.0 and contributing to our project.👍

The following are a set of guidelines for contributing to BurnOut. We are open to suggestions to enhance our project so feel free to propose changes to this document in a pull request.

Table of contents

Code of Conduct

How Can I Contribute?

Style Guides

Need additional help?

Code of Conduct

Everyone participating in this project needs to abide by the aPAS - A Personal Agile Scheduler Code of Conduct that can be found under the main repository link as a CODE_OF_CONDUCT.md file. By participating, you are expected to uphold this code. Please report unacceptable behavior to any of the original team members listed at the bottom of README.md.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for SE Group 26.

When you are creating a bug report, please ensure that you include as many details as possible to understand the issue.

How Do I Submit A Bug Report?

Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository. Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • If the problem is related to performance or memory, then ensure that you include a CPU profile capture with your report.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Suggesting Enhancements

This section guides you through submitting a suggestion for BurnOut, including completely new features and minor improvements to existing functionality.

Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the information like title, step-by-step description, specific examples.
Giving more detailed information will help us understand the suggestion better.

Provide details like

  1. What is the enhancement?
  2. Suggestions to implement the enhancement

Pull Requests Methods

The process described here has several goals:

  • Maintain BurnOut 2.0 quality
  • Fix problems that are important to the users
  • Engage the community in working towards the best possible BurnOut
  • Enable a sustainable system for Atom's maintainers to review contributions

Ensure that you follow the steps mentioned below in order to have your contribution reviewed by the maintainers:

  • Add a description of the modification.
  • Insert a clear and descriptive title.

Style Guides

Git Commit Messages

  • Describe why any particular modification is being made.

  • Give a detailed description about the limitations of current code.

  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")

  • Limit the first line to 72 characters or less

  • Link an issue to the change

Python Style Guides :

All Python code is linted with Pylint. Ensure that before you commit any changes, your code passes all the default pylint checks. Pylint can be installed with pip install pylint.

Need Additional Help?

Due to any reason, if you feel like you have reservations related to the process, feel free to reach us out at [[email protected]] Github process can be a bit complex and we don't want to lose your valuable contributions because of that reason. We are extremely glad that you have visited us and will make our project much better.