Skip to content

Commit 7bb90c1

Browse files
committed
(Smile) Added back 3 project files (WIP versions)
1 parent abc54ae commit 7bb90c1

File tree

3 files changed

+166
-0
lines changed

3 files changed

+166
-0
lines changed

CODE_OF_CONDUCT.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
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.
50+
Examples of
51+
representing a project or community include using an official project e-mail
52+
address, posting via an official social media account, or acting as an appointed
53+
representative at an online or offline event.
54+
Representation of a project may be
55+
further defined and clarified by project maintainers.
56+
57+
## Enforcement
58+
59+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
60+
reported by contacting the project team at railsgoat@gmail.com.
61+
All complaints will be reviewed and investigated and will result in a response that
62+
is deemed necessary and appropriate to the circumstances.
63+
The project team is
64+
obligated to maintain confidentiality with regard to the reporter of an incident.
65+
Further details of specific enforcement policies may be posted separately.
66+
67+
Project maintainers who do not follow or enforce the Code of Conduct in good
68+
faith may face temporary or permanent repercussions as determined by other
69+
members of the project's leadership.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
74+
available at [http://contributor-covenant.org/version/1/4][version]
75+
76+
[homepage]: http://contributor-covenant.org
77+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Ways to Contribute to RailsGoat
2+
3+
Thanks for your interest on contributing to RailsGoat!
4+
Here are a few general guidelines on contributing and reporting
5+
bugs to RailsGoat that we ask you to take a look first.
6+
Notice that all of your interactions in the project are
7+
expected to follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
8+
9+
## Reporting Issues
10+
11+
Before reporting a new issue, please be sure that the issue wasn't
12+
already reported or fixed by searching on GitHub through our
13+
[issues](https://github.com/OWASP/railsgoat/issues).
14+
15+
When creating a new issue, be sure to include a **title and clear description**,
16+
as much relevant information as possible, and either a test case example or
17+
even better a **sample Rails app that replicates the issue** -
18+
RailsGoat has a lot of moving parts and it's functionality can be affected
19+
by third party gems, so we need as much context and details as possible
20+
to identify what might be broken for you.
21+
22+
Avoid opening new issues to ask questions in our issues tracker.
23+
Please go through the project wiki, documentation and source code first,
24+
or try to ask your question in our
25+
[Slack Channel](https://owasp.slack.com/messages/C04THC44W).
26+
27+
If you find a security bug, do not report it through GitHub.
28+
Please send an e-mail to railsgoat@gmail.com instead.
29+
30+
## Sending Pull Requests
31+
32+
Before sending a new Pull Request, take a look on existing Pull Requests
33+
and Issues to see if the proposed change or fix has been discussed in
34+
the past, or if the change was already implemented but not yet released.
35+
36+
We expect new Pull Requests to include enough tests for new or changed
37+
behavior, and we aim to maintain everything as most backwards compatible
38+
as possible, reserving breaking changes to be ship in major releases
39+
when necessary
40+
41+
If your Pull Request includes new or changed behavior, be sure that the
42+
changes are beneficial to a wide range of use cases or it's an application
43+
specific change that might not be so valuable to other applications.
44+
45+
We also welcome Pull Requests that improve our existing documentation
46+
(both our `README.md` and the doc sections in the source code).
47+
48+
## Other Ways to Contribute
49+
50+
We welcome anyone that wants to contribute to RailsGoat to triage
51+
and reply to open issues to help troubleshoot and fix existing bugs
52+
on RailsGoat. Here is what you can do:
53+
54+
* Help ensure that existing issues follows the recommendations from the
55+
[Reporting Issues template](./ISSUE_TEMPLATE.md),
56+
providing feeback to the issue's author on what might be missing.
57+
* Review and update the existing content of our
58+
[Wiki](https://github.com/OWASP/railsgoat/wiki)
59+
with up to date instructions and code samples - the wiki was grown
60+
with several different tutorials and references that we can't keep
61+
track of everything, so if there is a page that showcases an integration
62+
or customization that you are familiar with feel free to update it
63+
as necessary.
64+
* Review existing Pull Requests, and testing patches against real
65+
existing applications that use RailsGoat.
66+
67+
Thanks again for your interest on contributing to the project!
68+
69+
:heart:

ISSUE_TEMPLATE.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!--- Provide a general summary of the issue in the Title above -->
2+
3+
🐞 **Problem**
4+
<!--- Provide a detailed description of the change or addition you are proposing -->
5+
<!--- If it is a feature or a bug, what problem is it solving-->
6+
7+
🎯 **Goal**
8+
<!--- Why is this change important to you? How would you use it? -->
9+
<!--- How can it benefit other users? -->
10+
11+
💡 **Possible solutions**
12+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
13+
14+
📋 **Steps to solve the problem**
15+
16+
* Comment below about what you've started working on.
17+
* Add, commit, push your changes
18+
* Submit a pull request and add this in comments - `Addresses #<put issue number here>`
19+
* Ask for a review in comments section of pull request
20+
* Celebrate your contribution to this project 🎉

0 commit comments

Comments
 (0)