Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 2.98 KB

CONTRIBUTIONS.md

File metadata and controls

76 lines (48 loc) · 2.98 KB

How to contribute

This document will explain how to contribute to N3UG.Club.Wev. Please read this document to have the best chance of successfully contributing

Submitting an Enhancement request or Bug Report

If you find a bug, or would like to request an enhancement, please create an issue so that the project team can manage the work and plan accordingly.

Before submitting a bug report, ensure that you have looked through the existing Issues for similar problems on the Issues page

If you don't see amything that looks like the issue you want to submit

please copy the following template and submit a new issue

============= START OF TEMPLATE =========================================

Example Title: Program crashes when deleting duplicated user records

Issue or Error Description

Give a detailed description about the issue or error here...

Process required to recreate the issue

Provide an ordered list of the process to finding and recreating the issue (example below)..

  1. Click "Admin" then "Users"
  2. Click the "edit" icon for the first listed User

What is the expected result?

Describe what you would expect to have resulted from this process...

What is the current result?

Describe what you you are currently experiencing from this process and any further information about the issue or error...

Possible Fix

Provide any information that may be useful for fixing the issue (Not required, but may be helpful)...

Screenshots

If relevant, include any necessary screenshots that may help someone find and fix the issue...

============= END OF TEMPLATE ===========================================

Making changes

The preferred method for making and submitting changes is as follows...Following these steps will give your Pull Request the best chance of being accepted.

  1. If you are addressing an existing issue, make note of the issue #
  2. Fork the N3UG.Club.Web DEV branch to your local repository
  3. Clone your local MASTER branch to your development machine
  4. Compile and run the Application to make sure everything is working as expected
  5. Make your code changes to add the enhancement or fix the bug
  6. TEST your code to make sure that not only is your code working, but that you haven't broken anything
  7. Commit and Push your changes to your local MASTER branch
  8. Create a Pull Request from your local MASTER branch to the N3UG.Club.Web DEV branch
  9. IMPORTANT !!! MAKE SURE TO INCLUDE THE ISSUE NUMBER AT THE END OF YOUR TITLE e.g.: Fixed error deleting duplicate users #14
  10. Make sure to add any comments that you think necessary that the reviewer should know when reviewing your PR

NOTE: Every attempt will be made to review and accept or respond to your Pull Request within 72 hours, however at certain times reviews may take longer due to lack of available time. Please be patient, your contribution is GREATLY appreciated.

Coding conventions

coming soon ...

Thanks Steve Fabian Northern NJ .NET User Group