Skip to content

Latest commit

 

History

History
42 lines (36 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

42 lines (36 loc) · 3.44 KB
Raw

Found a Problem? Have an Idea?

The easiest way to contribute is to create a detailed Issue. Be sure to include details about the version of OS, Access, and VCS add-in. If you can, provide a Minimal Reproducible Example of the problem.

Also be sure to check out the Project Wiki which contains detailed documentation and other helpful tips for using this add-in.

Development Version

If you want the very latest updates since the last published release, you will need to build it from source. Here is how to go from GitHub to git, to Access:

  • Make sure you have a fairly recent version of the add-in installed. If not:
    • Download the latest release.
    • Install the add-in. (Just open Version Control.accda.)
  • Clone this repository.
  • Pull your clone down to your local machine.
  • Choose a branch in git. (Typically dev)
  • Use the add-in to Build From Source, selecting the cloned Version Control.accda.src folder.
  • Run the newly compiled Version Control.accda file to install the development version.

Making your first Pull Request (PR)

A Pull Request is how you can propose that your code changes be included in the main project. (This project is the work of many people who have donated their efforts to make it better for everyone.) If you followed the steps to get to the Development Version then you can follow these steps to go back from Access to git, back up to GitHub:

  • Optional: For larger changes, you should consider making a branch that describes the changes you are proposing.
  • Open the development copy of Version Control.accda from the cloned GitHub project.
  • Perform testing on your development version.
  • Make updates to the database project. (This is where the magic happens)
  • When you are ready to make a commit run the Deploy procedure by typing Deploy into the VBA immediate window and press Enter. This will:
    • Increment the version number.
    • Export the project to source.
    • Install the version you have open.
  • Close Access.
  • Open an Access project and ensure that the version installed matches the new version you just deployed.
  • Perform testing to confirm that your new version works as expected.
  • Make a git commit* and briefly describe your changes in the commit notes. (You can add more verbose details in your pull request.)
    • *When creating the commit, please select only the files that reflect the actual changes you are proposing. It is usually not necessary to include auto-generated files that don't include substantive or intended changes.
  • Push your branch up to your cloned repository.
  • Make a pull request to the upstream project! Be sure to clearly describe what you did and why in the pull request. This will allow reviewers to better understand why your PR should be merged.
  • Pull requests should target the dev branch, where most active development takes place. Master branch PRs should be mainly limited to Wiki changes. Critical bug fixes can be cherry-picked over to the master branch if needed.
  • Tip: If you have many different types of changes to propose, please use different pull requests for each of them. That will be easier to review and implement them individually.

Thank you again for your support for the Microsoft Access development community!!