Skip to content

Commit

Permalink
📃 Added MD files
Browse files Browse the repository at this point in the history
- Added CODE_OF_CONDUCT
- Added CONTRIBUTING
- Added ISSUE_TEMPLATE
- Added contributors to README
  • Loading branch information
SaqibAMA committed Aug 9, 2020
1 parent 070807e commit c4a4733
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 1 deletion.
33 changes: 33 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## Code of Conduct

### Pledge

As someone who considers himself a beginner, I aim to develop and foster a community of beginner open-source contributors and maintainers with healthy participation. This also expands to a disregard for level of experience, ethnicity, gender identity, nationality, appearance, race, and orientation while interacting with this community.

### Standards

- 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.

### 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 pysaqib@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

Various points were taken from <a href="https://gist.github.com/PurpleBooth/b24679402957c63ec426">this repository</a>. Furthermore, this Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at <a href="http://contributor-covenant.org/version/1/4">http://contributor-covenant.org/version/1/4</a>
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Contributing

Hi there! I am glad that you're considering contributing to this project. Your efforts mean a lot for this repository and it's sustainability.

We have a simple pull request process that all contributors are required to comply with.

### Pull Request Process

1. Firstly, make sure the repository is forked and cloned on your system. This will allow for smooth and error-free development.

2. Make sure to use <b>g++</b> command-line compilation to run your code. This ensures consistency across platforms.

3. Since we are developing the library to be accessible for most computers, we require you to use standard libraries such as STL or common cross-platform libraries such as <i>iostream</i>. Avoid using platform-specific libraries such as Windows.h.

4. You may create a pull-request once you are completely satisfied with your contribution. The format of merge request should be "Added [insert what you have added]". Emojis are fine as long as they are not profane.

Try to follow <a href="https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html">good commit message</a> guidelines.

### Contribution License

All of the contributions made to the repository are published under the MIT License.
6 changes: 6 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Make sure all of these boxes are checked before submitting your issue--thank you!

- [] Check that you are running C++ 98 or above.
- [] Check that you are compiling on g++ command line compiler rather than a VS compiler.
- [] Check that your g++ compiler is configured in an appropriate way.
- [] Check that you have thoroughly gone through (demo.cpp).
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,9 @@ Training Wheels Urdu is a collection of C++ Macros that are designed to aid in p
- خیال رکھیے کے آپ کو بتایا ہوا ورژن ہی ڈونلوڈ کرنا ہے.
- کوڈ بلاکس میں نیا پراجیکٹ بناہے اور اس میں دونو فائلز رکھ دیں
- پھر اوپر دے ہوئے سبز رنگ کے پلے بٹن کو دباہے
- آپ کا پروگرام چل پڑیگا.
- آپ کا پروگرام چل پڑیگا.

## Contributors

@PySaqib
@ShahrozTanveer

0 comments on commit c4a4733

Please sign in to comment.