Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

68 lines (44 loc) · 3.39 KB

Contributing to WolfJobs!!

The following is a set of guidelines for contributing to WolfJobs. We are open to suggestions to enhance our project.

Table of Contents:

How can I contribute?

Labels Info

Labels Info

We have created labels for each issue for proper ordering and this will help you select an issue you would like to work on.

  • The documentation label is for problems regarding the entire documentation of this repo.

  • The enchancement label is for problems regarding any new / existing feature additions to be made in the project.

  • The bug label is for problems related to any bugs or fixes than need to be taken care of.

  • The tests label Adding missing tests or correcting existing tests

How can I contribute?

Reporting bugs

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

When you are creating a bug report, please 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.
  • 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.
  • 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 WolfJobs, 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

The process described here has several goals:

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