mirror of
https://github.com/yogeshojha/rengine.git
synced 2026-10-01 14:14:57 +02:00
Added contributors list
This commit is contained in:
Yogesh Ojha
@@ -0,0 +1,74 @@
|
||||
# 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, gender identity and expression, level of experience,
|
||||
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 yogesh.ojha11@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
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at [https://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: https://contributor-covenant.org
|
||||
[version]: https://contributor-covenant.org/version/1/4/
|
||||
@@ -0,0 +1,60 @@
|
||||
# Contributing to reNgine
|
||||
[](https://www.firsttimersonly.com/)
|
||||
|
||||
As an open-source project, reNgine welcomes any contributions. Your contributions could be as simple as fixing the indentations or fixing UI to as complex as bringing new modules and features.
|
||||
Your contributions are highly appreciated and we welcome any kind of contributions as long as you adhere to our guidelines and your PR aligns the idea behind creating the reNgine.
|
||||
|
||||
If you are new to open source community, reNgine is beginner-friendly. Please create pull requests for any new features, bug fixes, improvements on documentation, or anything!
|
||||
|
||||
Join our developer chat on [reNgine Slack channel](https://join.slack.com/t/reconengine/shared_invite/zt-figje4iu-~tgPstZXzqiBrDzl4Y1j5Q) if you would like to contribute to reNgine.
|
||||
|
||||
## Bug reporting
|
||||
|
||||
We appreciate your effort to improve reNgine by submitting a bug report. But, Before doing so, please check the following things:
|
||||
|
||||
1. Please **do not** use the issue tracker for personal support requests, instead use [reNgine Slack channel](https://join.slack.com/t/reconengine/shared_invite/zt-figje4iu-~tgPstZXzqiBrDzl4Y1j5Q) for any personal support request.
|
||||
2. Check whether the bug **hasn't been already reported**. Duplicate reports take us time, that we could be used to fix other bugs or make improvements.
|
||||
3. If you get an error while using reNgine, please **describe what happened** and add a verbose error message. Reports like "I got an error when I started scanning some random website." are not worth anybody's time. Please be as descriptive as you can.
|
||||
4. Provide easy steps to reproduce. This will help us solve your issues easily and quickly.
|
||||
Your contributions are again highly appreciated!
|
||||
|
||||
Please report [bugs here on GitHub Issues section][1].
|
||||
|
||||
[1]: https://github.com/yogeshojha/rengine/issues/new
|
||||
|
||||
|
||||
## Feature requests
|
||||
We welcome feature requests. But please take a moment to find out whether your idea fits with the original idea behind reEngine. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
|
||||
|
||||
## Pull requests
|
||||
Pull requests with a bug fix, improvements, new features are welcome and very much appreciated.
|
||||
|
||||
**Please ask** first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
|
||||
|
||||
### First Time Contributors
|
||||
If reNgine happens to be your first open-source project to contribute to, please follow the guidelines.
|
||||
|
||||
1. Fork this project.
|
||||
2. `git clone https://github.com/yourusername/rengine.git`
|
||||
3. Configure the remote as below
|
||||
```
|
||||
cd rengine
|
||||
# Assign upstream
|
||||
git remote add upstream https://github.com/yogeshojha/rengine.git
|
||||
```
|
||||
4. If cloning was done a while ago, please get the latest changes from upstream
|
||||
```
|
||||
git checkout master
|
||||
git pull upstream master
|
||||
```
|
||||
5. Commit your changes in the logical chunks
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
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.
|
||||
|
||||
## Thank you!
|
||||
|
||||
Thank you for contributing!
|
||||
@@ -0,0 +1,11 @@
|
||||
# Security Policy
|
||||
When I started out **rengine**, I had very little or no knowledge on Django. So I believe there could be many security vulnerabilities.
|
||||
Please report the security vulnerabilities via Issues Section or email yogesh.ojha11@(gmail).com
|
||||
|
||||
The community will be thankful to your contributions. :star:
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Please report all security issues [here](https://github.com/yogeshojha/rengine/issues) or email yogesh.ojha11@(gmail).com
|
||||
|
||||
## Past Security Vulnerabilities
|
||||
Reference in New Issue
Block a user