Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
cd sdjs-speaker-pipeline
upstream
remote for keeping your local repository up-to-date:
git remote add upstream https://github.com/sandiegojs/sdjs-speaker-pipeline.git
.env
file in the main directory and replace variables as needed. At a minimum you will need the following to be set:ADMIN_USERNAME=admin
ADMIN_EMAIL=your@email.com
ADMIN_PASSWORD=test
ADMIN_PHONE=6193331234
NODE_ENV=development
ADMIN_SPEAKER_EMAIL_TEMPLATE=XXXXXXXX
SENDGRID_API_KEY=XXXXXXX
npm install
to install the project dependenciesnpm run dev
to start your dev environment. This will automatically watch for changes to certain files and restart the server for you automatically.Make sure you have all the dependencies installed (npm install
), then from the command line you can run the tests using: npm run test
If you wish to run the tests manually and see the Cypress user interface you can run the server in development mode and then open the test interface. This can be helpful if you are writing new tests and you wish to run only some of the tests.
Start the server: npm run dev
Start the test interface: npm run cy:open
Make sure you are on the master
branch, and you have pulled the latest changes
git checkout master && git pull upstream master
Install any new dependencies: npm install
Create a new branch off of the master
branch
git checkout -b [NEW BRANCH NAME]
Branch naming conventions:
fix/[BRANCH]
for bug fixes
feature/[BRANCH]
for new features
dev/[BRANCH]
for non-user-facing changesThe
[BRANCH]
portion should be kebab case. For example, if you want to update the README.md file, your branch could be calleddev/update-readme
Make changes and commit them. git add . && git commit -m "[YOUR COMMIT MESSAGE]"
The subject of a commit message (the first line) should be 72 characters or less. If you need more room for a longer explanation of your changes, you can add a blank line below the subject and write a commit body. The commit message should be in present-imperative tense ("Update README.md" rather than "Updates" or "Updated").
Push your branch to your fork: git push -u origin [BRANCH NAME]
Open a new PR against the master
branch from your fork using the GitHub user interface