Skip to content

Commit

Permalink
add PR template, code of conduct, contributing and code owners
Browse files Browse the repository at this point in the history
  • Loading branch information
diogoViana95 committed Dec 10, 2023
1 parent 9e6d0f5 commit f7a946e
Show file tree
Hide file tree
Showing 4 changed files with 142 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- @diogoViana95 @rcarvalho8998
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## Pull Request

### Description

<!-- Provide a brief description of the changes in this pull request. -->

### Related Issue

<!-- If this pull request is related to any GitHub issue, mention it here. -->
<!-- Example: Closes #123 -->

### Checklist

<!-- Mark the items that apply to this pull request using [x]. -->

- [ ] I have read and followed the [contributing guidelines](CONTRIBUTING.md), if available.
- [ ] My code follows the project's coding standards.
- [ ] I have written tests for my changes, if applicable.
- [ ] My changes generate no new warnings or errors.
- [ ] I have updated the documentation accordingly, if necessary.

### Screenshots (if applicable)

<!-- Include screenshots or animated GIFs that demonstrate the changes visually. -->

### Additional Notes

<!-- Any additional information that might be relevant to reviewers. -->

---

### Reviewers

<!-- Mention any specific team members or individuals you'd like to review this pull request. -->

@reviewer1
@reviewer2
47 changes: 47 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# 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 with 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 email 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 [diogoviana@deadcow.enterprises](mailto:diogoviana@deadcow.enterprises). 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 2.0,
available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][version]

[homepage]: https://www.contributor-covenant.org
[version]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
57 changes: 57 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Contributing to Report Metric Service

Welcome to Report Metric Service! We appreciate your interest in contributing.

## How to Contribute

1. Fork the repository to your GitHub account.
2. Clone the forked repository to your local machine:

```bash
git clone https://github.com/your-username/your-project.git
```

3. Create a new branch for your changes:

```bash
git checkout -b feature/your-feature
```

4. Make your changes and commit them:

```bash
git add .
git commit -m "Your descriptive commit message"
```

5. Push the changes to your GitHub repository:

```bash
git push origin feature/your-feature
```

6. Open a pull request (PR) from your branch to the main repository's `main` or `master` branch.
7. Follow the PR template provided in `PULL_REQUEST_TEMPLATE.md`.
## Code Style
Please follow the coding standards defined in the project. If there are no specific guidelines, maintain consistency with the existing code.
## Testing
If your contribution involves code changes, make sure to add or update tests to cover the new functionality or changes.
## Reporting Issues
If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.
## Code of Conduct
This project follows a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold this code.
## License
By contributing to this project, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE).

Thank you for contributing to [Your Project Name]!

0 comments on commit f7a946e

Please sign in to comment.