Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

59 lines (44 loc) · 2.88 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Reporting bugs

Report bugs at https://github.com/EOSC-synergy/eosc-perf-frontend/issues

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • If you can, provide detailed steps to reproduce the bug.
  • If you don't have steps to reproduce the bug, just note your observations in as much detail as you can. Questions to start a discussion about the issue are welcome.

Submit Feedback

The best way to send feedback is to file an issue at the follwing URL:

https://github.com/EOSC-synergy/eosc-perf-frontend/issues

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Pull Request Process

You are welcome to open Pull Requests for either fixing a bug, adding a new feature, contributing to the documentation, etc.

  1. Fork the repository and create a new branch from main.
  2. If you’ve fixed a bug or added code that should be tested, add tests!
  3. Document your code using jsdoc.
  4. Ensure the test suite passes: yarn test.
  5. Make sure your code lints (for example via yarn lint).
  6. Ensure your code is formatted using prettier.
  7. Update the README.md with details of changes, e.g. new environment variables, exposed ports, container parameters etc.
  8. Name your commits using Conventional Commits.
  9. Push the changes to your fork.
  10. Create a Pull Request to this repository.
  11. Review and address comments on your pull request.

Coding Standards