Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (47 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

87 lines (47 loc) · 2.28 KB

CONTRIBUTING to HW2b

First off, thank you for taking the time to contribute!

The following is the guidelines for contributing to hw2b on GitHub. These are mostly guidelines, not rules.

Before Getting Started

  • You need to know the packages you need.
  • You need to make sure the design decisions.
    • when you make a significant decision, you need to know how you maintain the project and what you can or cannot support.
    • submit the meaningful questions bravely.

Getting Started

  • Make sure you have GitHub account.

  • Make the repository on GitHub.

How to Contribute

First, you need to report bugs, you can create bug reports and please include as many details as possible. The information it asks can help to resolve the problem faster.

Then, suggest enhancements. You can submit an enhancement suggestion for our project, including completely new features and minor improvements to existing functionality. You also need to suggest as many details as possible which can help to understand the suggestion and find the related suggestions.

Documentation Guide

  • Use markdown for .md documents.

Pull Requests

The process described here has several goals:

  • Maintain project quality.
  • Fix problems that are important to users.
  • Engage the community in working.
  • Enable a sustainable system for project maintainers to review contributions.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Committing Changes

You first need to follow the pull request above.

Then, please avoid working directly on master branch and you need to create a new branch from where you want to start your work.

Last but not least, you need to write meaningful commit messages and test for your changes.

Submitting Changes

  • Push the changes to the repository.
  • Submit a pull request to the original repository and follow the pull requests above.
  • Wait for feedback on the request.

Table of Contents

  • .gitignore

  • .trivis.yml

  • CITATION.md

  • CODE-OF-CONDUCT.md

  • CONTRIBUTING.md

  • LICENSE.md

  • README.md

  • setup.py

  • requirements.txt

  • code/

    _init _.py

  • test/

    README.md

  • data/

    README.md