CONTRIBUTING.md

Contributing to Malga Node.js

Welcome and thanks for your interest! Before submitting a pull request, please take a moment to review these guidelines.

Reporting Issues

Found a problem? Want a new feature?

• See if your issue or idea has already been reported.
• Provide a live example.

Remember, a bug is a demonstrable problem caused by our code.

Submitting Pull Requests

Pull requests are the greatest contributions, so be sure they are focused in scope and avoid unrelated commits.

1. To begin: fork this project, clone your fork, and add our upstream.

   # Clone your fork of the repo into the current directory
   git clone [email protected]:$(npx github-username-cli $(git config user.email))/malga-tokenization.git
   
   # Navigate to the newly cloned directory
   cd malga-tokenization
   
   # Assign the original repo to a remote called "upstream"
   git remote add upstream [email protected]:plughacker/malga-tokenization.git
   
   # Install the tools necessary for testing
   yarn install

2. Create a branch for your feature or fix:

   # Move into a new branch for your feature
   git checkout -b feature/thing

   # Move into a new branch for your fix
   git checkout -b fix/something

3. If your code passes all the tests, then push your feature branch:

   # Test current code
   yarn test
   
   # Build current code
   yarn build

   Note: ensure your version of Node is 18 or higher to run scripts

   # Push the branch for your new feature
   git push origin feature/thing

   # Or, push the branch for your update
   git push origin update/something

That’s it! Now open a pull request with a clear title and description.