- JS
- TypeScript
- Golang
- Ruby/Crystal
- Solidity
- Official JS Style Guide: JavaScript Semi-Standard, and TS Semi Standard
- Official GoLang Style Guide: Uber GoLang Style Guide
- Official Ruby Style Guide: The Ruby Style Guide
- Official Crystal Style Guide: Crystal Lang Official Coding Style
- Official Solidity Style Guide: 0xcert Solidity Style Guide
- Step 1 Clone Repo locally and make a feature branch that coinsides with your jira ticket
- If no Jira Ticket exists, create one and tag Your Flight Pilot and Head of Engineering
- branch should be named as follows for ticket
NC-99
,feature/NC-99
- When that particular ticket is complete make a pull request to your repos
development
branch - The peer-reviewer assigned must review within 1 business day
- Peer reviewer will verify any tests pass, they understand the code, and it meets the appropriate style guide
- Flight Pilot or Head of Engineering will ensure that the repo satisfies the ask in the Jira ticket
- Head of Product will ensure that the ticket accomplishes what was intended
- Every week whatever is in the Development Branches must be tested and either merged to main or a reason must be given why they cannot be
- Each week each Flight will demo it's progress
- Pull Request will use the official Seventh Ave Pull Request Template
### Is this PR for a specific JIRA task? If yes, what’s the JIRA task ID?
- [ ] Yes. (*Leave this unchecked if your answer is: No.*)
<!--- Provide the exact ID of your task here (e.g., "SC-50"). -->
### Does your code compile/build without errors?
- [ ] Yes. (*Leave this unchecked if your answer is: No.*)
### Did you merge the master/develop branch into your branch?
- [ ] Master
- [ ] Develop
(*Leave this unchecked if your answer is: No.*)
### Are your changes/updates visual? If yes, insert a screenshot/GIF/video of your changes/updates.
- [ ] Yes. (*Leave this unchecked if your answer is: No.*)
<!--- Insert a screenshot/GIF/video of your changes/updates here. -->
- JS Repos will use
husky
,commitlint
,@commitlint/config-conventional
andlint-staged
- This will ensure all commits meet guidelines
- All APIs must be documented with either
Docco
,Swagger
orJSDoc
- All Readme's must have up to date information about starting app.
- The master doc site that will go live next week will be the source of truth for all practices of Engineering (Built with Gatsby)