CONTRIBUTING.md

Contributing to Elucid

The Elucid Team would like to thank you for your interest in helping to maintain and improve Elucid!

If you plan on modifying the website, follow these steps beforehand

There are 3 npm actions you need to run before working:

• First go to website within demo and run npm install
• Second run npm run build within the same directory
• Third use npm run develop to launch the website

Optional for server-side changes:

• Go to server within demo and run npm install

If you plan on modifying the package, follow these steps beforehand

• Navigate to elucid folder and run npm install to download dependencies

Reporting Bugs

All code changes happen through Github Pull Requests and we actively welcome them. To submit your pull request, follow the steps below:

Pull Requests

1. Fork the repo and create your branch from main.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the tests pass.
5. Make sure your code lints.
6. Submit a pull request.

Note: Any contributions you make will be under the ISC Software License and your submissions are understood to be under the same that covers the project. Please reach out to the team if you have any questions.

Issues

We use GitHub issues to track bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. 4. Ensure the test suite passes. 5. Make sure your code lints. 6. Issue that pull request!

Note: Any contributions you make will be under the MIT Software License and your submissions are understood to be under the same that covers the project. Please reach out to the team if you have any questions.

Coding Style

2 spaces for indentation rather than tabs 80 character line length

License

By contributing, you agree that your contributions will be licensed under Elucid's ISC License.