Skip to content

Commit

Permalink
create contributing guidelines and code of conduct
Browse files Browse the repository at this point in the history
  • Loading branch information
shakyapeiris committed Dec 21, 2021
1 parent d5172d6 commit 7faa0e5
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 0 deletions.
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make 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 [shakyaimanjith32@gmail.com](mailto:shakyaimanjith32@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/
49 changes: 49 additions & 0 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing To Auth Bee

Hi, first of all I'd like to thank you for contributing AuthBee. It's people like you who makes AuthBee like tools great tools for developers.

Following these guidelines helps to communicate that you respect the time of the fellow developers managing and developing this project. In return, the also should hel you in addressing your issue, assessing changes, and helping to finalize your pull request.

## What are the ways you can contribute to AuthBee?

There are many ways you can contrbute to thi project such as,

- Improving Documentations
- Bug triaging
- Writing tutorials about Authbee
- Feature requests, etc...

## Ground Rules

- Ensure cross-platform compaitibility for every change you make.
- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
- Keep feature versions as small as possible, preferably one new feature per version.

## Is this your first contribution?

No problems. Everyone one was once a beginner. First you can start by checking issues with `good first issue` which are specifically kept for beginners. Also, we recommend you to refer this [article](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github) before making your pull request.

## Getting started

1. If you havent installed, please install `Node.Js` and `git`
2. First make a fork of the repo and clone the forked repo into your machine.
3. Then install all the dependencies by running `npm install`
4. Next make your changes.
5. Run `npm run lint` & `npm run test` to check whether there's no any issue in linting or testing.
6. Next push changes in to your forked repo.
7. Then create a pull request to the main repo from you forked repo.

## How to report a bug?

When reporting a bug we highly encourage you to use the provided template. Else, you can create a custom issue but we'll not consider it, if it does not has following points.

- Expected behaviour
- Your environment details (browser version, etc...)
- Your node version
- Steps to reproduce the behaviour

## How to suggest a feature?

If you find yourself wishing for a feature that doesn't exist in AuthBee, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that AuthBee has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.

## So that's it and Thank You again for your support in improving AuthBee 🐝

0 comments on commit 7faa0e5

Please sign in to comment.