Skip to content

Commit

Permalink
Add Code of Conduct and Contribution Guide page (#88)
Browse files Browse the repository at this point in the history
* Created Contribution_Guide.md

* Created Code_of_Conduct.md
  • Loading branch information
chlawrence31 authored Feb 24, 2024
1 parent d0a8bfe commit 24eda15
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
17 changes: 17 additions & 0 deletions Code_of_Conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Code of Conduct
As a community our goal is to create a welcome and safe environment for people of all backgrounds and create an open and welcoming community.

## Examples of Behaviors
### Examples of Positive and Fostering Behaviors:
* Demonstrating empathy and kindness towards others while communicating.
* Being respectful of others viewpoints.
* Giving and responding to constructive feedback respectfully.

### Examples of Negative and Unacceptable Behaviors:
* Using hurtful and derogatory language towards others.
* Making any sort of personal attack.
* Harassment of any kind.
* Any conduct not appropriate in a professional setting.

This code of conduct applies to any form of communication in the scope of this project including individual conversations as well as group posts like issues and pull requests.
If you feel like anything in this code of conduct has been breached in some way reach out to a communinity leader so they can address the issue.
15 changes: 15 additions & 0 deletions Contribution_Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contribution Guide
Thank you for taking the time to contribute and improve our project, the following guidelines will help you with your contribution and explain the review process.

## Reporting Bugs or Suggesting Features
If you would like to report a bug or suggest a new feature or improvement to the code, documentation or anything else about the project first check the current issues to see if your comment has already been reported. If not feel free to open a new issue and state the problem. While describing a bug be specific, explain everything you did to create the bug so whoever is working on it can replicate the bug and better understand what was causing it.

## Submitting Changes
Once you have found a potential feature to add or an issue to address follow these basic steps:
1. Create a fork of the project.
2. Create one or more commits of the changes you made being specific on your changes in your commit message so your changes can be clearly tracked and understood.
3. Test your changes thoroughly to make sure everything still works as intended and your new change works properly with the rest of the project.
4. Push your changes to your fork.
5. Open a pull request with your fork and summarize the problem you solved as well as your solution that you implemented.

Once you have submitted a pull request your changes will be promptly reviewed and you will either recieve feeback or have the changes accepted and merged.

0 comments on commit 24eda15

Please sign in to comment.