✨ Thank you for taking the time to contribute to this project ✨
This project adheres to the American Express Code of Conduct. By contributing, you are expected to honor these guidelines.
-
Fork the repository
holocron
to your GitHub account. -
Afterwards run the following commands in your terminal Please review this tutorial to learn how to clone a repository https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository
$ git clone https://github.com/<your-github-username>/holocron $ cd holocron
replace
your-github-username
with your github username -
Install the dependencies by running
$ yarn
-
You can now run the scripts within the different packages.
- Run the "Manually Publish" Github action. This will trigger a release from the
main
branch.
When submitting a new feature request or enhancement of an existing features please review the following:
Please provide a clear and concise description of what you want and what your use case is.
Please include a snippets of the code of the new feature.
A clear and concise description of the enhancement to be added include a step-by-step guide if applicable. Add any other context or screenshots or animated GIFs about the feature request.
A clear and concise description of any alternative solutions or features you've considered.
All issues are submitted within GitHub issues. Please check this before submitting a new issue.
A clear and concise description of what the bug is.
Please provide code snippets or a link to a repository, with steps to reproduce the behavior, failure or topic of discussion.
Please provide a description of the expected behavior
If applicable, add screenshots or animated GIFs to help explain your problem.
Provide the system information which is not limited to the below:
- OS: [e.g. macOS, Windows]
- Browser (if applies) [e.g. chrome, safari]
- Version of faux-cdn: [e.g. 5.0.0]
- Node version:[e.g 10.15.1]
Please review our Security Policy. Please follow the instructions outlined in the policy.
- Join our Slack channel request an invite here
We follow conventional commits for git commit message formatting. These rules make it easier to review commit logs and improve contextual understanding of code changes. This also allows us to auto-generate the CHANGELOG from commit messages.