Skip to content

Commit

Permalink
docs: added CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
csautter committed Oct 14, 2024
1 parent 4470456 commit ad27457
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Contributing to myeia
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

## Report bugs using Github's [issues](https://github.com/philsv/myeia/issues/)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/philsv/myeia/issues/new); it's that easy!

Write bug reports with detail, background, and sample code if possible. **Great Bug Reports** tend to have:

- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- 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)

## Github Actions
We use Github Actions to automate the testing and deployment of the package. The workflow is defined in the `.github/workflows` directory.
To get your code merged into the main branch, you need to pass the tests. Feel free to extend the tests to cover your code.
For a successful test run it's necessary to [set the EIA_TOKEN as secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) in your Fork.

## License
By contributing, you agree that your contributions will be licensed under its [MIT License](LICENSE).
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,3 +227,8 @@ Date
2021-01-25 2.602
... ...
```

## Contributing
We love your input! We want to make contributing to this project as easy and transparent as possible.
Read our [CONTRIBUTING.md](CONTRIBUTING.md) to get started.

0 comments on commit ad27457

Please sign in to comment.