Refactor data file - Githubissues

knowbee / rwanda

🇷🇼This is a simple npm package that returns provinces, districts, sectors, villages and cells from Rwanda

https://www.npmjs.com/package/rwanda

MIT License

47 stars 20 forks source link

Refactor data file #1

Closed oesukam closed 4 years ago

oesukam commented 4 years ago

What does this PR do?

This PR puts provinces, districts and sectors into different files in order to improve the code maintainability

How to test?

Clone the repo

Use the snippet below


const { Provinces, Districts } = require('rwanda');

console.log(Provinces()); // [ 'East', 'Kigali', 'North', 'South', 'West' ] console.log(Districts()); // [ 'Bugesera', 'Gatsibo', 'Kayonza', 'Kirehe',...]

oesukam commented 4 years ago

@knowbee Thanks for the feedback. I just updated it to develop.

knowbee commented 4 years ago

@knowbee Thanks for the feedback. I just updated it to develop.

You can also rename you branch to ft-refactor-data-file or feature-refactor-data-file so that future pull requests follow the same format. Thanks

oesukam commented 4 years ago

@knowbee I think ft or feature would more make sens if it was about adding a new feature but this PR doesn't change the current implementation but only refactor the codebase. We can maybe have feature (New feature), refactor (Refactor the codebase), bug (fixing bug), chore (improving the development environment)

knowbee commented 4 years ago

@knowbee I think ft or feature would more make sens if it was about adding a new feature but this PR doesn't change the current implementation but only refactor the codebase. We can maybe have feature (New feature), refactor (Refactor the codebase), bug (fixing bug), chore (improving the development environment)

sounds about right 👌, update accordingly.

knowbee commented 4 years ago

@knowbee I think ft or feature would more make sens if it was about adding a new feature but this PR doesn't change the current implementation but only refactor the codebase. We can maybe have feature (New feature), refactor (Refactor the codebase), bug (fixing bug), chore (improving the development environment)

sounds about right 👌, update accordingly.

I have updated contributing guideline with your naming convention suggestion. check it out

oesukam commented 4 years ago

@knowbee Under Branch naming, instead of Summary, I think it should be Example as refactor-data-file

oesukam commented 4 years ago

@knowbee If possible to also add the link to the contribution guideline in the readme for easy access