Pull Request Template
We believe that crafting good code is not enough. Programming is about being disclipined. Pull Requests are an extension of this value when it comes to collaborative programming.
This document is a standard for raising Pull Requests for any of Skcript's repos on Github.
How to use:
- Click on the file PULL_REQUEST_TEMPLATE.md
- Click on Raw
- Copy the contents of the page
- Create a new file in your repo called PULL_REQUEST_TEMPLATE.md
- Paste the content you copied earlier
Format:
This PR template follows a specific format that works well for Skcript. But it could vary from one organization to the other.
Proposed Changes
List down the proposed changes in bullets. Make sure all the changes are covered. End to end.
Types of Changes
Listing down the type of change is very important. If the changes are breaking, it goes through intense code quality checks and bug tests before it is pushed to production or to the customer.
Code Quality Checklist
Announcing whether the code has gone through some intense testing under some of the testing tools that we use is important.
Further Comments
Any other comment about this particular PR goes here.
Reviewers
List of reviewers who can approve this PR. List people who are outside of Github here. If the Reviewer is on Github, plug them in under the Reviewers section of a particular PR.
Authors
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details.
MIT License
Copyright (c) 2017 Skcript
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
About
This Project is maintained by Skcript. The names and logos for Skcript are properties of Skcript.
We love open source, and we have been doing quite a bit of contributions to the community. Take a look at them here. Also, encourage people around us to get involved in community operations. Join us, if you'd like to see the world change from our HQ.