Skip to content

Commit

Permalink
add .github things (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
ErnestTeluk authored Oct 29, 2024
1 parent ee51e05 commit ef9a2a8
Show file tree
Hide file tree
Showing 5 changed files with 60 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 @@
* @ErnestTeluk @DamianErtel
31 changes: 31 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# How to contribute

Third-party patches are essential for keeping every project great. We simply can't access the huge number of use cases. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow to have a chance of keeping on top of things.

## Getting started

- Make sure you have a [GitHub account](https://github.com/signup/free).
- Submit a ticket for your issue, assuming one does not already exist.
- It is OK to comment an already closed issue or review already merged PR.
- If needed, we'll reopen it or open a new one.
- Add a list of affected versions of the core, bridge, and theme packages you are aware of.
- Include other versions as well, if you think it may help (React, browser, etc.).

## Making changes

- Create a fork from where you want to base your work.
- Clone the repo and run `npm ci` **in the top-level only**.
- Make sure you are using `npm` that understands the `package-lock.json` format. At the moment, it's at least v7.
- Make sure your commit messages are in the proper format:
- Bugfix or feature:
- `Implemented asynchronous validation (closes #17).`
- `Disabled onSubmit until first render (closes #15).`
- Other changes:
- `Refactored joinName tests.`
- `Updated README.md.`
- Make sure you have added the necessary tests for your changes. Do not worry though, the Codecov bot will report it in the pull request.
- Make sure your code passes _all_ tests: `npm test`.

## _Work in progress_ PRs are also welcome

If you can't or won't finish your PR, submit it anyway - maybe someone else will continue your work. If you don't know how to achieve your desired feature - file an issue for it - maybe someone else will implement it.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Bug report
about: Found a bug? Tell us about it!
---

Before you open an issue, please check if a similar one already exists or has been closed before. Detailed information about the process of contributing can be found in [CONTRIBUTING.md](https://github.com/vazco/uniforms-cli/blob/main/.github/CONTRIBUTING.md).

Let us know what is happening. Do provide us with:

- Affected versions of the core, bridge, and theme packages you are aware of.
- Include other versions as well, if you think it may help (React, browser, etc.).
- Steps to reproduce.
- Possible workarounds, if you've found any.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Feature request
about: Have an idea? Let's talk!
---

Before you open an issue, please check if a similar one already exists or has been closed before. Detailed information about the process of contributing can be found in [CONTRIBUTING.md](https://github.com/vazco/uniforms-cli/blob/main/.github/CONTRIBUTING.md).

Let us know what you'd like to see. Do provide us with:

- Motivation why you'd like to see this in uniforms.
- Examples of how others could use this feature.
- Possible workarounds, if applicable.
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Before you open a pull request, please check if a similar one already exists or has been closed before. Detailed information about the process of contributing can be found in [CONTRIBUTING.md](https://github.com/vazco/uniforms-cli/blob/main/.github/CONTRIBUTING.md).

Do link all relevant issues and pull requests. If there is none, please do file an issue first to discuss it upfront.

0 comments on commit ef9a2a8

Please sign in to comment.