Skip to content

Latest commit

 

History

History
91 lines (54 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

91 lines (54 loc) · 3.35 KB

Contributing to Fraudit

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Code of Conduct

This project and everyone participating in it is governed by the Fraudit Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

What should I know before I get started?

Project Overview and Structure

Here you might want to explain the structure of your project and anything else someone would need to know to understand the where and why of your project.

Software dependencies

List all the major software dependencies and how to install them.

How Can I Contribute?

Reporting Bugs

Before Submitting A Bug Report

  • Make sure you're on the latest version. If you are not on the most recent version, please update and verify that the issue still exists.
  • Check the existing issues to ensure you aren't duplicating work.

How To Submit A Bug Report

Bugs are tracked as GitHub issues. Create an issue on the repository and provide the following information by filling in this template.

Suggesting Enhancements

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

Before creating enhancement suggestions, please check if there's already an issue addressing this topic/idea.

Your First Code Contribution

Unsure where to begin contributing to Fraudit? You can start by looking through these beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

Here are a few steps you should follow when creating a pull request:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your machine.
  3. Create a new branch for your changes.
  4. Make your changes in the new branch.
  5. Commit your changes and push them to your repository.
  6. Submit a pull request to the original repository.

Pull Request Checklist

  • I have followed the style guidelines for this project.
  • I have performed a self-review of my own code.
  • I have commented on my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.

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.

Documentation Styleguide

  • Use Markdown.
  • Reference your methods and classes in the code itself, where applicable.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

Questions?

Don't hesitate to ask questions in the project discussions page. We're here to help!

Happy contributing!