Hi! Thanks for taking the time to contribute to the HMRC Multichannel Digital Tax Platform (MDTP)
We welcome contributions to hmrc-frontend-scaffold. By following these guidelines you will greatly improve the likelihood of your change being accepted and merged.
We’re always looking for feedback and help. These are the areas where you can get involved:
- Bug fixes and improvements
- Proposing new features
- Documentation
If you're looking to add new screens, please ensure they align with the HMRC Design System.
Before starting on a piece of work, please get in touch.
We may already have what you’re planning to do in our backlog, already be working on it, or be planning an alternative solution or approach.
Communicating early can also help with design decisions and direction for your approach, increasing the chance of us accepting your work.
Please come and talk to us in our Slack channel in the first instance. Once we've discussed your idea, we'll probably ask you to raise an issue (using our Issue template) before starting work.
Once you've identified (or created) an issue to work on, please follow these guidelines to contribute code:
- Fork the repository
- Write tests along with your code
- Add logical, atomic commits with good commit messages
- Raise your Pull Request against the
developbranch using our Pull Request template - We will review and offer any feedback
- Once merged to
develop, we will coordinate a merge intomainand a release
Writing good commit messages is important. Not just for yourself, but for other developers on your project. This includes:
- new (or recently absent) developers who want to get up to speed on progress
- interested external parties who want to follow progress of the project
- people in the public (remember, we code in the open) who want to see our work, or learn from our practices
- any future developers (including yourself) who want to see why a change was made
Recommended reading on this topic