├── CODE-OF-CONDUCT.md
├── CONTRIBUTING.md
├── README.md
├── _config.yml
└── assets
└── logo.png
/CODE-OF-CONDUCT.md:
--------------------------------------------------------------------------------
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, gender identity and expression, level of experience,
9 | nationality, personal appearance, race, religion, or sexual identity and
10 | 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 npalash25@outlook.com. 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 [http://contributor-covenant.org/version/1/4][version]
72 |
73 | [homepage]: http://contributor-covenant.org
74 | [version]: http://contributor-covenant.org/version/1/4/
75 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contribution Guidelines
2 |
3 | Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
4 |
5 | # The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away. It should be more descriptive than that.
6 |
7 | ## Table of Contents
8 |
9 | - [Adding to this list](#adding-to-this-list)
10 | - [Creating your own awesome list](#creating-your-own-awesome-list)
11 | - [Adding something to an awesome list](#adding-something-to-an-awesome-list)
12 | - [Updating your Pull Request](#updating-your-pull-request)
13 |
14 | ## Adding to this list
15 |
16 | Please ensure your pull request adheres to the following guidelines:
17 |
18 | - Search previous suggestions before making a new one, as yours may be a duplicate.
19 | - Make sure the the programme is useful before submitting and is offered by an organization working in the doamin of Computer Science and Software Development.
20 | - Make an individual pull request for each suggestion.
21 | - Use [title-casing](http://titlecapitalization.com) (AP style).
22 | - Use the following format: `[Programme Name](link)`
23 | - Check your spelling and grammar.
24 | - Make sure your text editor is set to remove trailing whitespace.
25 | - The pull request and commit should have a useful title.
26 |
27 | Thank you for your suggestions!
28 |
29 | ## Creating your own awesome list
30 |
31 | To create your own list, check out the [instructions](create-list.md).
32 |
33 | ## Adding something to an awesome list
34 |
35 | If you have something awesome to contribute to an awesome list, this is how you do it.
36 |
37 | You'll need a [GitHub account](https://github.com/join)!
38 |
39 | 1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
40 | 2. Click on the `readme.md` file: 
41 | 3. Now click on the edit icon. 
42 | 4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). 
43 | 5. Say why you're proposing the changes, and then click on "Propose file change". 
44 | 6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
45 |
46 | ## Updating your Pull Request
47 |
48 | Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.
49 |
50 | [Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.
51 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
8 | What is an awesome list? 9 | Contribution guide 10 | Follow me on Twitter 11 |
12 | 13 |