Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (53 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

87 lines (53 loc) · 2.92 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue before making a change.

Please note there is a code of conduct, please follow it in all your interactions with the project.

Reporting Issues and Asking Questions

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Development

Visit the issue tracker to find a list of open issues that need attention.

Fork, then clone the repo:

git clone https://github.com/your-username/conjunction.git

Unicorn

The project uses Unicorn to serialize Sitecore items related to Conjunction, i.e template items, settings etc.

In order to use Unicorn you need to do the following:

  1. Publish the Conjunction.Foundation.Content project, using a custom file system publish profile, to your local Sitecore instance
  2. Copy the Unicorn.CustomSerializationFolder.config.example file from the App_Config/Include/Unicorn folder to the App_Config/Include/z_Developer folder
  3. Rename the copied file to remove the .example extension
  4. Edit the file to point at the serialization folder beneath your working folder
  5. Run http://<yoursite>/unicorn.aspx and sync everything

Tests

Tests are located in the *.Tests projects and are using xUnit.net. By default, the test projects use Visual Studio runner to run the tests.

Docs

Improvements to the documentation are always welcome. In the docs we abide by typographic rules, so instead of ' you should use '. Same goes for “ ” and dashes (—) where appropriate. These rules only apply to the text, not to code blocks.

Installing Gitbook

To install the latest version of gitbook and prepare to build the documentation, run the following:

npm run docs:prepare

Building the Docs

To build the documentation, run the following:

npm run docs:build

To watch and rebuild documentation when changes occur, run the following:

npm run docs:watch

The docs will be served at http://localhost:4000.

Publishing the Docs

To publish the documentation, run the following:

npm run docs:publish

Sending a Pull Request

In general, the contribution workflow looks like this:

  • Open a new issue in the issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the master branch.
  • Make sure all tests pass.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, I'll get back to you as soon as possible.

Thank you for contributing!