Skip to content

Commit a6cd818

Browse files
committed
Open Source Guides added
1 parent 0c8584f commit a6cd818

File tree

3 files changed

+105
-2
lines changed

3 files changed

+105
-2
lines changed

.github/pull_request_template.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
### Fixes:
2+
-
3+
-
4+
-
5+
6+
### Changes:
7+
-
8+
-
9+
-
10+
11+
12+
### Thank you for your contribution!
13+
14+
Please note the following points for pull request
15+
16+
- Make sure that the pull request is not a duplicate.
17+
- Follow the same code style as the library.
18+
- Pull request should target the `dev` branch.
19+
- Don't alter the licence headers.
20+
- Run the test suites in the `test` directory first by running `npm test` or `gulp test`.
21+
- Don't modify any files in the `dist` directory.
22+
- Link any issue that is related to the pull request.
23+
- Provide a description of your changes.
24+
25+
IMPORTANT: Please review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
26+
27+
**YOU CAN REMOVE THIS PR TEMPLATE BEFORE SUBMITTING**

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing
22

33
## How can I contribute?
4-
- Fix a bug found or already reported on the [GitHub Issues Tracker](https://github.com/techlab/SmartWizard/issues/).
4+
- Fix a bug you found or already reported on the [GitHub Issues Tracker](https://github.com/techlab/SmartWizard/issues/).
55
- Add new features to the project.
66
- Create new themes
77
- Add new test cases.
@@ -13,7 +13,7 @@
1313
Here are the basic steps to get started contributing code:
1414

1515
1. Fork the [repo](https://github.com/techlab/SmartWizard/) and get development running on your computer.
16-
2. Install the npm development dependencies by the command `npm install` on the project folder (Assumes you already have NodeJS installed).
16+
2. Install the npm development dependencies by the command `npm install` on the project folder (Should have NodeJS installed).
1717
3. Replicate the issue you're trying to fix or spec out the feature you're trying to add.
1818
4. Run `gulp watch` before start changing code. It will auto build and bundle the `.js` and `.css` files when you change.
1919
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.

0 commit comments

Comments
 (0)