-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 add contributing file 📝 add issue template 📝 add PR template Signed-off-by: birjuvachhani <[email protected]>
- Loading branch information
1 parent
4ea20d3
commit 1eb10aa
Showing
4 changed files
with
212 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 [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. | ||
|
||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Contributing | ||
We'd love for you to contribute to our source code and to make the project even better than it is today! | ||
Here are the guidelines we'd like you to follow: | ||
|
||
- [Code of Conduct](#coc) | ||
- [Git Commit Messages](#commit) | ||
- [Got a Question or Problem?](#question) | ||
- [Found an Issue?](#issue) | ||
|
||
## <a name="coc"></a> Code of Conduct | ||
[Code of Conduct](https://github.com/BirjuVachhani/spider/blob/master/CODE_OF_CONDUCT.md) | ||
|
||
## <a name="commit"></a> Git Commit Messages | ||
|
||
* Use the present tense ("Add feature" not "Added feature") | ||
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") | ||
* Limit the first line to 72 characters or less | ||
* Reference issues and pull requests liberally after the first line | ||
* When only changing documentation, include `[ci skip]` in the commit title | ||
* Consider starting the commit message with an applicable emoji: | ||
* :art: `:art:` when improving the format/structure of the code | ||
* :racehorse: `:racehorse:` when improving performance | ||
* :non-potable_water: `:non-potable_water:` when plugging memory leaks | ||
* :memo: `:memo:` when writing docs | ||
* :bug: `:bug:` when fixing a bug | ||
* :fire: `:fire:` when removing code or files | ||
* :green_heart: `:green_heart:` when fixing the CI build | ||
* :white_check_mark: `:white_check_mark:` when adding tests | ||
* :lock: `:lock:` when dealing with security | ||
* :arrow_up: `:arrow_up:` when upgrading dependencies | ||
* :arrow_down: `:arrow_down:` when downgrading dependencies | ||
* :shirt: `:shirt:` when removing lint/checkstyle warnings | ||
|
||
Find all the available emojis [here](https://gitmoji.carloscuesta.me/). | ||
|
||
## <a name="question"></a> Got a Question or Problem? | ||
|
||
If you feel that we're missing an important bit of documentation, feel free to | ||
file an issue so we can help. Here's an example to get you started: | ||
|
||
``` | ||
What are you trying to do or find out more about? | ||
Where have you looked? | ||
Where did you expect to find this information? | ||
``` | ||
|
||
## <a name="issue"></a> Found an Issue? | ||
If you find a bug in the source code or a mistake in the documentation, you can help us by | ||
submitting an issue to our project. | ||
|
||
To submit an issue, please check the [Issue Template](https://github.com/BirjuVachhani/spider/blob/master/ISSUE_TEMPLATE.md). | ||
|
||
Even better you can submit a Pull Request with a fix. | ||
|
||
### Pull Request | ||
To generate a pull request, please consider following [Pull Request Template](https://github.com/BirjuVachhani/spider/blob/master/PULL_REQUEST_TEMPLATE.md). | ||
|
||
* Search [GitHub](https://github.com/BirjuVachhani/spider/pulls) for an open or closed Pull Request | ||
that relates to your submission. You don't want to duplicate effort. | ||
* Please have a look at [License](https://github.com/BirjuVachhani/spider/blob/master/LICENSE) before sending pull | ||
requests. We cannot accept code without this. | ||
|
||
That's it! Thank you for your contribution! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
### Prerequisites | ||
|
||
* [ ] Put an X between the brackets on this line if you have done all of the following: | ||
* Reproduced the problem | ||
* Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=is%3Aissue+user%3ABirjuVachhani | ||
|
||
### Description | ||
|
||
[Description of the issue] | ||
|
||
### Steps to Reproduce | ||
|
||
1. [First Step] | ||
2. [Second Step] | ||
3. [and so on...] | ||
|
||
**Expected behavior:** [What you expect to happen] | ||
|
||
**Actual behavior:** [What actually happens] | ||
|
||
**Reproduces how often:** [What percentage of the time does it reproduce?] | ||
|
||
### Additional Information | ||
|
||
Any additional information, configuration or data that might be necessary to reproduce the issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
### Requirements | ||
|
||
* Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion. | ||
* All new code requires tests to ensure against regressions | ||
|
||
### Description of the Change | ||
|
||
<!-- | ||
We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts. | ||
--> | ||
|
||
### Alternate Designs | ||
|
||
<!-- Explain what other alternates were considered and why the proposed version was selected --> | ||
|
||
### Why Should This Be In Core? | ||
|
||
<!-- Explain why this functionality should be in atom/atom as opposed to a package --> | ||
|
||
### Benefits | ||
|
||
<!-- What benefits will be realized by the code change? --> | ||
|
||
### Possible Drawbacks | ||
|
||
<!-- What are the possible side-effects or negative impacts of the code change? --> | ||
|
||
### Verification Process | ||
|
||
<!-- | ||
What process did you follow to verify that your change has the desired effects? | ||
- How did you verify that all new functionality works as expected? | ||
- How did you verify that all changed functionality works as expected? | ||
- How did you verify that the change has not introduced any regressions? | ||
Describe the actions you performed (e.g., buttons you clicked, text you typed, commands you ran, etc.), and describe the results you observed. | ||
--> | ||
|
||
### Applicable Issues | ||
|
||
<!-- Enter any applicable Issues here --> |