diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b150791495d..b95562fbc13 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,22 +2,15 @@ ## Change Description - - - -## Consensus Changes -- [ ] Consensus Changes - - - - -## API Changes -- [ ] API Changes - - - + ## Documentation Additions - [ ] Documentation Additions + +## Pushing The Code + + +## Unit Test Coverage + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 256e871d7a9..09c80c364b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to eos +# Contributing to WAX Interested in contributing? That's awesome! Here are some guidelines to get started quickly and easily: @@ -6,7 +6,7 @@ Interested in contributing? That's awesome! Here are some guidelines to get star - [Bug Reports](#bug-reports) - [Feature Requests](#feature-requests) - [Change Requests](#change-requests) -- [Working on eos](#working-on-eos) +- [Working on WAX](#working-on-WAX) - [Feature Branches](#feature-branches) - [Submitting Pull Requests](#submitting-pull-requests) - [Testing and Quality Assurance](#testing-and-quality-assurance) @@ -16,7 +16,7 @@ Interested in contributing? That's awesome! Here are some guidelines to get star ## Reporting An Issue -If you're about to raise an issue because you think you've found a problem with eos, or you'd like to make a request for a new feature in the codebase, or any other reason… please read this first. +If you're about to raise an issue because you think you've found a problem with WAX, or you'd like to make a request for a new feature in the codebase, or any other reason… please read this first. The GitHub issue tracker is the preferred channel for [bug reports](#bug-reports), [feature requests](#feature-requests), and [submitting pull requests](#submitting-pull-requests), but please respect the following restrictions: @@ -34,12 +34,12 @@ Guidelines for bug reports: reported. 1. **Check if the issue has been fixed** — look for [closed issues in the - current milestone](https://github.com/EOSIO/eos/issues?q=is%3Aissue+is%3Aclosed) or try to reproduce it + current milestone](https://github.com/worldwide-asset-exchange/wax-blockchain/issues?q=is%3Aissue+is%3Aclosed) or try to reproduce it using the latest `develop` branch. A good bug report shouldn't leave others needing to chase you up for more information. Be sure to include the details of your environment and relevant tests that demonstrate the failure. -[Report a bug](https://github.com/EOSIO/eos/issues/new?title=Bug%3A) +[Report a bug](https://github.com/worldwide-asset-exchange/wax-blockchain/issues/new) ### Feature Requests @@ -51,15 +51,15 @@ Feature requests are welcome. Before you submit one be sure to have: ### Change Requests -Change requests cover both architectural and functional changes to how eos works. If you have an idea for a new or different dependency, a refactor, or an improvement to a feature, etc - please be sure to: +Change requests cover both architectural and functional changes to how WAX works. If you have an idea for a new or different dependency, a refactor, or an improvement to a feature, etc - please be sure to: 1. **Use the GitHub search** and check someone else didn't get there first 1. Take a moment to think about the best way to make a case for, and explain what you're thinking. Are you sure this shouldn't really be a [bug report](#bug-reports) or a [feature request](#feature-requests)? Is it really one idea or is it many? What's the context? What problem are you solving? Why is what you are suggesting better than what's already there? -## Working on eos +## Working on WAX -Code contributions are welcome and encouraged! If you are looking for a good place to start, check out the [good first issue](https://github.com/EOSIO/eos/labels/good%20first%20issue) label in GitHub issues. +WAX provides a pull request template that helps you to create your pull request. It is located at .github/PULL_REQUEST_TEMPLATE.md so that it is automatically loaded on PR creation. Just follow the instructions. Also, please follow these guidelines when submitting code: @@ -67,8 +67,8 @@ Also, please follow these guidelines when submitting code: To get it out of the way: -- **[develop](https://github.com/EOSIO/eos/tree/develop)** is the development branch. All work on the next release happens here so you should generally branch off `develop`. Do **NOT** use this branch for a production site. -- **[master](https://github.com/EOSIO/eos/tree/master)** contains the latest release of eos. This branch may be used in production. Do **NOT** use this branch to work on eos's source. +- **[develop](https://github.com/worldwide-asset-exchange/wax-blockchain/tree/develop)** is the development branch. All work on the next release happens here so you should generally branch off `develop`. Do **NOT** use this branch for a production site. +- **[master](https://github.com/worldwide-asset-exchange/wax-blockchain/tree/master)** contains the latest release of WAX. This branch may be used in production. Do **NOT** use this branch to work on wax's source. ### Submitting Pull Requests @@ -78,7 +78,7 @@ Pull requests are awesome. If you're looking to raise a PR for something which d Never underestimate just how useful quality assurance is. If you're looking to get involved with the code base and don't know where to start, checking out and testing a pull request is one of the most useful things you could do. -Essentially, [check out the latest develop branch](#working-on-eos), take it for a spin, and if you find anything odd, please follow the [bug report guidelines](#bug-reports) and let us know! +Essentially, [check out the latest develop branch](#working-on-wax), take it for a spin, and if you find anything odd, please follow the [bug report guidelines](#bug-reports) and let us know! ## Conduct