Skip to content

Commit

Permalink
Contributing (#521)
Browse files Browse the repository at this point in the history
* added contributing.md

* added code of conduct

* fix links
  • Loading branch information
jeromehardaway authored Nov 2, 2023
1 parent ca00b39 commit ca94533
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Remember, this is optional. If you prefer to set up your development environment

## Contributing :handshake:

We love contributions! Please read our [Contributing Guidelines](https://github.com/Vets-Who-Code/vwc-site/blob/master/.github/contributing.md) to get started.
We love contributions! Please read our [Contributing Guidelines](contributing.md) to get started.

## Roadmap 🗺️

Expand Down
48 changes: 48 additions & 0 deletions code_of_conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# 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, 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.
- Deliberate intimidation, stalking, or following.
- Harassing photography or recording.
- Sustained disruption of talks or other events.
- Inappropriate physical contact.
- Advocating for, or encouraging, any of the above behaviors.
- Publishing others' private information, such as a physical or electronic address, without explicit permission.
- Other conduct that is inappropriate for a professional or shared professional environment.

## 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 Jerome Hardaway directly via slack. 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, version 1.4, code of conduct.
57 changes: 57 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# CONTRIBUTING to Vets Who Code Web App

Hello and thank you for your interest in contributing to the Vets Who Code web app. We appreciate your effort and support. This document provides guidelines for contributing.

## Table of Contents

1. [Code of Conduct](#code-of-conduct)
2. [Getting Started](#getting-started)
3. [Reporting Bugs](#reporting-bugs)
4. [Feature Requests](#feature-requests)
5. [Pull Request Process](#pull-request-process)
6. [Code Style and Linting](#code-style-and-linting)
7. [Testing](#testing)
8. [Further Help](#further-help)

## Code of Conduct

Our community has a [Code of Conduct](code_of_conduct.md), and we ask that you read and follow it. This helps ensure a welcoming and inclusive environment for everyone.

## Getting Started

- Make sure you have a [GitHub account](https://github.com/).
- Fork the repository on GitHub.
- Clone your fork to your local machine.

## Reporting Bugs

- Ensure the bug hasn't already been reported by searching the Issues.
- If the bug hasn't been reported, open a new Issue. Be sure to provide a clear title, a detailed description, and steps to reproduce the issue.

## Feature Requests

- Check if the feature has already been requested.
- If it hasn't, open a new Issue with a clear title and detailed description of the feature you'd like to see.

## Pull Request Process

1. Create a new branch for your feature or fix.
2. Make your changes, ensuring you follow the code style guidelines.
3. Commit your changes, using a clear and descriptive commit message.
4. Push your branch to GitHub.
5. Open a Pull Request against the main branch.
6. Ensure your PR description clearly describes the problem and solution.

## Code Style and Linting

- We use [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) for code styling and linting. Make sure your code adheres to our configurations.
- Run the linter before submitting a PR to ensure your code passes.

## Testing

- Add tests for any new features or fixes.
- Ensure all tests pass before submitting a PR.

## Further Help

If you have any questions or need further assistance, please reach out to (Jerome Hardaway)[https://github.com/jeromehardaway].

1 comment on commit ca94533

@vercel
Copy link

@vercel vercel bot commented on ca94533 Nov 2, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.