lukebrandonfarrell / README

👋 - The documentation for contributing to Aspect Apps

Welcome to the Aspect Apps contribution documentation! Yes... documentation, at Aspect Apps we strive for streamlined systems, that includes documentation, no more and no less. If you are new here, then please read on how to contribute to both our internal and open-source projects.

Existing Open Source Contributors

To make a contribution to one of our open-source reepositories, clone the repo:

git clone https://github.com/aspect-apps/name-of-repo

After cloning the repository make the required changes and create a pull request to the parent repository. We follow Conventional Commits specification, this will be enforced with a pre-commit hook.

Once the pull request is merged a Github action will be triggered and publish the version to NPM (versioing based on the commit message)! All our repositories are powered via Semantic Release.

New Open Source Projects

If you are part of the Aspect Apps core team and want to create a new open source repository, there are a few steps you need to take. All our repositories require a set of technolgogies for automated release and linting, to make the setup easier you can run a script which will install all of the required packages.

• Firstly, create a new repository on Github (you will need to check that the name is available on NPM before you click "Creeate repository")

• Then run the following commands, to setup the repository (replace my-new-os-repo with the name of the repository you created):

git clone https://github.com/aspect-apps/my-new-os-repo
cd ./my-new-os-repo
echo "# my-new-os-repo" >> README.md
git init
git remote add origin https://github.com/aspect-apps/my-new-os-repo.git

Once you have created your project, you can run the install-open-source-automation.sh by downloading it onto your computer from the /scripts folder and running bash install-open-source-automation.sh in your project. If your project uses typescript, you can pass a -typescript flag i.e. bash install-open-source-automation.sh -typescript. This will install the following:

• Commitlint to verify commit message format.
• Husky, Lint Staged and Prettier for commit hooks and linting.
• Semantic Release setup with Github Actions to automate git and NPM releases.