Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 5.29 KB

CONTRIBUTING.md

File metadata and controls

98 lines (64 loc) · 5.29 KB
Raw

Contributing to Buttono

First, thank you for considering contributing to Buttono! It's people like you that make the open source community such a great community!

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Using the issue tracker

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests, but please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests.
  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.
  • Please do not post comments consisting solely of "+1" or ":thumbsup:". Use GitHub's "reactions" feature instead. We reserve the right to delete comments which violate this rule.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

  1. Validate and lint your code — validate your HTML to ensure your problem isn't caused by a simple error in your own code.

  2. Use the GitHub issue search — check if the issue has already been reported.

  3. Check if the issue has been fixed — try to reproduce it using the latest master branch in the repository.

  4. Isolate the problem — ideally create a reduced test case and a live example. You may use Codepen to show the problem.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Feature requests

Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Submit a Pull Request

If you'd like to make some changes yourself, see the following:

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Make sure yarn is globally installed (npm install -g yarn).
  3. Run yarn to download required packages.
  4. Run yarn build to build.
  5. Start the application: yarn start
  6. Lint your code before submit a pull request (yarn lint).
  7. Update website if necessary (check website/README.md for more information).
  8. Finally, submit a pull request with your changes into develop branch!

Commit Messages

Commit messages should be verb based, using the following pattern:

Note: Add the prefix website: to the commit messages if the changes are related to the website.

  • Fix ...
  • Add ...
  • Update ...
  • Remove ...
  • website: Fix ...
  • website: Add ...
  • website: Update ...
  • website: Remove ...

Coding style

Please follow the coding style of the project. buttono uses stylelint, so if possible, enable linting in your editor to get real-time feedback. The linting rules can be run manually with the following command yarn lint.

You can also run yarn format to reformat the code.

Finally, when you submit a pull request, they are run again by Circle CI, but hopefully by then your code is already clean!

License

By contributing your code, you agree to license your contribution under the MIT license