Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.93 KB
Raw

🚀 Welcome to FlakeGuard contribution, we are thrillled to have you here! 🚀

How Do I submit A (Good) Pull Request?

All pull requests will be reviewed by the authors and will either be

  1. Denied
  2. Denied with feedback
  3. Approved contingent upon minor changes
  4. Approved and merged

Testing

Please write Jest, or React Testing Library files to test the new code you create.

Pull Request

Please send a Pull Request to FlakeGuard with a clear list of what you've done (read more about pull requests). When you send a pull request, we will love you forever if you include RSpec examples. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits, including a summary and a detailed paragraph about all changes and testing.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub Issues.

  1. Create an issue and provide the following information by filling in the template.
  2. 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. 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.

If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information.