Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 1.4 KB

How to contribute

First of all, thank you for taking the time to contribute to this project. We've tried to make a stable project and try to fix bugs and add new features continuously. You can help us do more.

Before you start, read the README.md file for info on the project and how to set it up.

Best Practices

Before you post any issue or pull request, search the issues and the pull requests to see if it has already been addressed.

Here are some best practices that will help us accept/address pull requests and issues:

  • Outline one, and only one, specific problem/feature that you are trying to address.
  • Write a good title that summarizes the specific problem.
  • Introduce the problem before you write any code.
  • Help us reproduce the problem if applicable with a jsfiddle/codepen showcasing the need for a solution.

Pull Requests

Fork, then clone the repo:

git clone git@github.com:your-username/notice.js.git

Make your changes and push to your fork and submit a pull request.

At this point you're waiting on us. We may suggest some changes or improvements or alternatives.