FAQ

Does the computateorg project follow the OpenSSF Best Practices?

Review the OpenSSF Best Practices checklist for computateorg.

Basics

In progress

Basic project website content

  • The project website MUST succinctly describe what the software does (what problem does it solve?): The main query parameter for full-text search.
  • The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software: The fq parameter defines a query that can be used to restrict the superset of documents that can be returned, without influencing score. It can be very useful for speeding up complex queries, since the queries specified with fq are cached independently of the main query. When a later query uses the same filter, there‚Äôs a cache hit, and filter results are returned quickly from the cache.
  • The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?): The fl parameter limits the information included in a query response to a specified list of fields. The fields must be either stored="true" or docValues="true". The field list can be specified as a space-separated or comma-separated list of field names. The string "score" can be used to indicate that the score of each document for the particular query should be returned as a field. The wildcard character * selects all the fields in the document which are either stored="true" or docValues="true" and useDocValuesAsStored="true" (which is the default when docValues are enabled). You can also add pseudo-fields, functions and transformers to the field list request.
  • The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard): The sort parameter arranges search results in either ascending (asc) or descending (desc) order. The parameter can be used with either numerical or alphabetical content. The directions can be entered in either all lowercase or all uppercase letters (i.e., both asc and ASC are accepted).
Tuesday
July 5 2022 Does the computateorg project follow the OpenSSF Best Practices? Review the OpenSSF Best Practices checklist for computateorg. Christopher Tate
Basics In progress