From a6cd81805dc918a1ca1ed3c0bd64f6a4e66a1adf Mon Sep 17 00:00:00 2001 From: Dipu Raj Date: Wed, 5 Feb 2020 12:00:21 +0530 Subject: [PATCH] Open Source Guides added --- .github/pull_request_template.md | 27 ++++++++++++ CODE_OF_CONDUCT.md | 76 ++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 4 +- 3 files changed, 105 insertions(+), 2 deletions(-) create mode 100644 .github/pull_request_template.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..68b2678 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,27 @@ +### Fixes: + - + - + - + +### Changes: + - + - + - + + +### Thank you for your contribution! + +Please note the following points for pull request + +- Make sure that the pull request is not a duplicate. +- Follow the same code style as the library. +- Pull request should target the `dev` branch. +- Don't alter the licence headers. +- Run the test suites in the `test` directory first by running `npm test` or `gulp test`. +- Don't modify any files in the `dist` directory. +- Link any issue that is related to the pull request. +- Provide a description of your changes. + +IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines. + +**YOU CAN REMOVE THIS PR TEMPLATE BEFORE SUBMITTING** diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..eaaecf4 --- /dev/null +++ b/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 dipumedayil@gmail.com. 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/CONTRIBUTING.md b/CONTRIBUTING.md index bfb5939..07c7bdc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing ## How can I contribute? -- Fix a bug found or already reported on the [GitHub Issues Tracker](https://github.com/techlab/SmartWizard/issues/). +- Fix a bug you found or already reported on the [GitHub Issues Tracker](https://github.com/techlab/SmartWizard/issues/). - Add new features to the project. - Create new themes - Add new test cases. @@ -13,7 +13,7 @@ Here are the basic steps to get started contributing code: 1. Fork the [repo](https://github.com/techlab/SmartWizard/) and get development running on your computer. -2. Install the npm development dependencies by the command `npm install` on the project folder (Assumes you already have NodeJS installed). +2. Install the npm development dependencies by the command `npm install` on the project folder (Should have NodeJS installed). 3. Replicate the issue you're trying to fix or spec out the feature you're trying to add. 4. Run `gulp watch` before start changing code. It will auto build and bundle the `.js` and `.css` files when you change. 5. Change the code to fix the bug or add the feature. All changes should happen in the relevant `src/js/*.js` and `src/css/*.css` files.