Skip to content

Commit

Permalink
docs: update CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa committed Nov 8, 2023
1 parent 97e0a61 commit 6fa0a00
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,25 @@

We love your input! 🚀 We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug.
- Discussing the current state of the code.
- Submitting a fix.
- Proposing new features.
- [Reporting a bug](https://github.com/rickstaa/action-create-tag/issues).
- [Discussing the current state of the code](https://github.com/rickstaa/action-create-tag/discussions).
- [Submitting a fix](https://github.com/rickstaa/action-create-tag/pulls).
- [Proposing new features](https://github.com/rickstaa/action-create-tag/issues).
- Becoming a maintainer.

## We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.
We use github to host code, track issues and feature requests, and accept pull requests.

## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:

1. Fork the repo and create your branch from `master`.
2. If you've added code that should be tested, add tests.
1. Fork the repo and create your branch from `main`.
2. Add tests if you've added code that should be tested.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!
5. Issue that pull request!

## Any contributions you make will be under the MIT Software License

Expand All @@ -40,8 +39,8 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
- A quick summary and/or background.
- Steps to reproduce:
- Be specific!
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that _anyone_ with a base R setup can run to reproduce the error.
- What you expected would happen.
- Give sample code if you can. [This stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that _anyone_ with a base R setup can run to reproduce the error.
- What you expected would happen
- What actually happens.
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work).

Expand Down

0 comments on commit 6fa0a00

Please sign in to comment.