Skip to content

Commit b55f894

Browse files
authored
Rename README, Contributing and added Code_of_conduct. (#93)
* Fixed Worflows of autocomment on prs * Rename Contributing.md * Rename Readme, Contributing and added Code_of_conduct.md * Fixed The workflows to run on different branch PR. * Revert "Fixed The workflows to run on different branch PR." This reverts commit 482bf40.
1 parent 2c20bca commit b55f894

File tree

3 files changed

+45
-2
lines changed

3 files changed

+45
-2
lines changed

CODE_OF_CONDUCT.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Code of Conduct
2+
3+
### Our Pledge
4+
5+
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, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
### Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
### Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
### Scope
32+
33+
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.
34+
35+
### Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. 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.
38+
39+
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.
40+
41+
### Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), [version 1.4](http://contributor-covenant.org/version/1/4/).

Contributing.md renamed to CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Please note we have a code of conduct, please follow it in all your interactions
1313
## Pull Requests
1414

1515
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
16-
2. Update the ReadMe.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
16+
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
1717
3. We strictly use GitFlow and try to have a linear merge. Please follow the guidelines below.
1818
4. Make sure your code has been prettified by Prettier & ES Lint before pushing. We use this [VS Code Config](https://gist.github.com/praveenscience/ebb5439f31774ad2fdc14cb9e7de1fc0).
1919

ReadMe.md renamed to README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Here are some quick and simple instructions, which no one can mess up! 💪🏻
123123
1. If the issue is already assigned to someone else, please enter your comment but look through and try to see how you can fit.
124124
2. If it’s not already assigned, tell how you can solve this issue, explain your procedure in your mind and ask to assign.
125125
6. If you can’t find any issues, identify potential bugs or improvements for the project! 🔎
126-
7. Once you’ve been assigned the issue, kindly follow the [Contributing Guidelines](./Contributing.md) and make a Pull Request! 🤝🏻
126+
7. Once you’ve been assigned the issue, kindly follow the [Contributing Guidelines](./CONTRIBUTING.md) and make a Pull Request! 🤝🏻
127127
8. I’ll go through your PR and if it’s of good quality, congrats, thanks for your contribution. 😁
128128
9. Occasionally, if there are some issues, I’ll definitely point them out and I won’t close the PRs without a valid info! 🥹
129129

0 commit comments

Comments
 (0)