Skip to content
This repository has been archived by the owner on Jun 12, 2024. It is now read-only.

Commit

Permalink
added contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Saturn226 committed Nov 21, 2023
1 parent c7ed358 commit 1b0db1d
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## Contributing

[pr]: https://github.com/education/autograding-command-grader/compare
[style]: https://github.com/github/gh-classroom/blob/main/.golangci.yaml
[release-docs]: https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license
[good-commit-msg]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are [released][release-docs] to the public under the [project's open source license](./LICENSE.txt).

Please note that this project is released with a [Contributor Code of Conduct](./CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.

## Submitting a pull request

1. Clone the repository
1. Create a new branch: `git checkout -b my-branch-name`
1. Make your change, add tests, and make sure the tests and linter still pass
1. [submit a pull request][pr]
1. Please be patient while waiting for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

- Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a [good commit message][good-commit-msg].

## Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)

0 comments on commit 1b0db1d

Please sign in to comment.