Skip to content

Latest commit

 

History

History
79 lines (50 loc) · 3.91 KB

CONTRIBUTING.md

File metadata and controls

79 lines (50 loc) · 3.91 KB
Raw

CONTRIBUTING

Your contributions to this project are highly appreciated. Please adhere to this guide to streamline the process for everyone.

By contributing code to this project, you agree to license your contribution under the GNU Affero General Public License.

Code Formatting and Linting Process

In our development workflow, we prioritize code quality through the use of the highly opinionated code formatter, Prettier. We have automated the formatting and linting processes on every staged commit to ensure that our codebase adheres to consistent standards.

Feel free to reach out if you have any questions or need further clarification on our code formatting and linting practices.

Issues

Use issues exclusively for bug reporting and proposing enhancements.

When reporting bugs, describe the problem clearly and provide all relevant information to replicate it. Describe both the expected and actual behavior as detailed as possible.

🐛 File a bug report ✨ Propose enhancement

Pull Requests

To contribute fork the project, then submit a Pull-Request with your changes, targeting the dev branch.

Commit Formatting

We use conventional commits for continuous deployment, versioning, and changelog creation.

Once npm install is executed, git hooks aid in the committing process. Should the hooks not install automatically, run npm rebuild husky. Use git commit to commit your changes; Commitizen assists in crafting a structured commit message. To complete the commit, close the text editor that appears (typically with ctrl + x), and then git push as usual.

Getting Started

Make sure you have Node.js 8 or higher and npm installed.

  1. Fork this repository and clone your fork
  2. Install dependencies: npm install
  3. Run a development server: npm start

Running Tests

Testing is a crucial part of any software project. For all but the most trivial changes (typos, etc) test cases are expected. Tests are run in actual browsers using Karma.

  • In all available and supported browsers: npm test
  • In a specific browser: npm run test:chrome, npm run test:firefox, etc.
  • While development server is running (npm start), navigate to http://localhost:9999/test/

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Questions?

For inquiries other than bug reports or feature requests, please send an email to our support team at support@ceeblue.net.