Skip to content

Latest commit

 

History

History
104 lines (70 loc) · 4.62 KB

CONTRIBUTING.md

File metadata and controls

104 lines (70 loc) · 4.62 KB
Raw

#Contributing to Wirefy

♥ Wirefy and want to get involved? We would love that and you've made us blush. First thank you so much. Now there are plenty of ways you can help.

Reporting Issues

A bug is caused by a coding problem located in the repository. These can hinder users from getting the most out of Wirefy. We want to reduce the number of bugs and issues found within the code.

Please review the following guidelines before you report an issue:

  1. Use the GitHub issue search — to see if the issue has already been reported. If it has been, please only comment on the existing issue.

  2. Check if the issue has been fixed — the latest master or development branch may already contain a fix. Always grab the latest code to work from.

  3. Isolate the problem — make sure that the code in the project's repository is definitely responsible for the issue. Create a reduced test case - an extremely simple and immediately viewable example of the issue.

  4. Include a live example — provide a link to your reduced test case when appropriate (e.g. if the issue is related to (front-end technologies). Please use jsFiddle or codepen to host examples.

Please be as detailed as possible in your report too. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to assess and fix any potential bugs.

Example Bug Report:

Short and descriptive 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).

A good bug report shouldn't leave people needing to chase you up to get further information that is required to assess or fix the bug.

File a bug report

Pull Requests

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

If your contribution involves a significant amount of work or substantial changes to any part of the project, please open an issue to discuss it first.

Please follow this process; it's the best way to get your work included in the project:

  1. Fork the project.

  2. Clone your fork (git clone https://github.com/<your-username>/wirefy.git).

  3. Add an upstream remote (git remote add upstream https://github.com/cjdsie/wirefy.git).

  4. Get the latest changes from upstream (e.g. git pull upstream <dev-branch>).

  5. Create a new topic branch to contain your feature, change, or fix (git checkout -b <topic-branch-name>).

  6. Make sure that your changes adhere to the current coding conventions used throughout the project - indentation, accurate comments, etc. Please update any documentation that is relevant to the change you are making.

  7. Commit your changes in logical chunks; use git's interactive rebase feature to tidy up your commits before making them public. Please adhere to these git commit message guidelines or your pull request is unlikely be merged into the main project.

  8. Locally merge (or rebase) the upstream branch into your topic branch.

  9. Push your topic branch up to your fork (git push origin <topic-branch-name>).

  10. Open a Pull Request with a clear title and description. Please mention which browsers you tested in.

Examples and Tutorial

If you've been working with Wirefy and would like to share your work with the world, we want to hear from you. We will feature you as an example. Get in touch with the subject line of I'm using Wirefy.

You can also help others with Wirefy by writing tutorials or articles about the ways you use the code. We will then compile that list and forward new users to your site.