diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3f19ef9 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at contact@dzcode.io. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..2b10334 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing to kuliya + +Contributions are always welcome. Before contributing please read the +[code of conduct](https://github.com/dzcode-io/kuliya/blob/master/.github/CODE_OF_CONDUCT.md) & +[search the issue tracker](https://github.com/dzcode-io/kuliya/issues); your issue +may have already been discussed or fixed in `master`. To contribute, +[fork](https://help.github.com/articles/fork-a-repo/) kuliya, commit your changes, +& [send a pull request](https://help.github.com/articles/using-pull-requests/). + +## Do you have a suggestion? + +Feature requests should be submitted in the +[issue tracker](https://github.com/dzcode-io/kuliya/issues/new/choose), with a description of +the expected behavior & use case. +Before submitting a request, please search for similar ones in the +[closed issues](https://github.com/dzcode-io/kuliya/issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement). + +## Did you find a bug? + +When logging a bug, please be sure to answer the following: + +- A clear and concise description of what the bug is +- If at all possible, an _isolated_ way to reproduce the behavior +- The behavior you expect to see, and the actual behavior + +## Do you have a question? + +The issue tracker is for **issues**, in other words, bugs and suggestions. +If you have a _question_, please contact us via [EMail](mailto:contact@dzcode.io) or any of our social links. + +## Coding Guidelines + +In addition to the following guidelines, please follow the conventions already +established in the code. + +- **Spacing**:
+ Use two spaces for indentation. No tabs. + +- **Naming**:
+ Keep variable & method names concise & descriptive.
+ Variable names `index`, `array`, & `iteratee` are preferable to + `i`, `arr`, & `fn`. + +- **Quotes**:
+ Double-quoted strings are chosen over single-quoted strings; to avoid unnecessary escaping. + +- **Comments**:
+ Please use single-line comments to annotate significant additions, & + [JSDoc-style](http://www.2ality.com/2011/08/jsdoc-intro.html) comments for + functions. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..609799b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +labels: bug +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error +5. ...etc + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment:** + +- OS: [e.g. Windows 10] +- Browser : [e.g. IE 11] +- Runtime [e.g. JRE 8] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2356405 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project +labels: enhancement +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..37e23fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,23 @@ +--- +name: Question +about: The issue tracker is not for questions. Please use email contact@dzcode.io or other social links for help/questions. +labels: question +--- + + diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md new file mode 100644 index 0000000..ce20d0f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.md @@ -0,0 +1,34 @@ +--- +name: Task +about: Create a ticket for specific task(s) +labels: task +--- + +**Description** + + + +**Check List** + +1. [ ] Add cool feature +2. [ ] Add test cases +3. [ ] Update the readme +4. ...etc + +**Additional Comments** + + + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..7f2c6b2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ +# Description + + + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update +- [ ] Updated the dataset