Coder Social home page Coder Social logo

Comments (4)

vsoch avatar vsoch commented on August 29, 2024

The tests are self documenting in that (given that they exist) they run, and in that something doesn't work, it will issue an error. In the case of credentials or custom settings in CircleCI I could see the need to document this, however this repository has no special settings or secrets, everything that is needed is represented in the .circleci/config.yml and .github/workflows. In the case that changes (e.g., some external integration is added or a secret / permission is needed, we can re-address this issue).

from usrse.github.io.

vsoch avatar vsoch commented on August 29, 2024

Actually, let me flip this suggestion on its head! What I think would be useful to do is to append the already existing notes with a comment that there aren't any secrets or permissions to be worried about. I'll also re-organize into sections for each of Travis, CircleCI, and GitHub. That should meet the requirements of this request.

from usrse.github.io.

vsoch avatar vsoch commented on August 29, 2024

Putting myself in the shoes of someone not familiar with the testing, this is how I see it playing out:

Currently

  • some security breach / thing is announced
  • "Oh no, I think usrse.github.io uses that!"
  • arrives at repo, no notes (panic)

With Updates

  • some security breach / thing is announced
  • "Oh no, I think usrse.github.io uses that!"
  • arrives at repo, see notes, no cause for alarm.

I need to shower / meeting / finish something for a deadline but I'll do this soon too.

from usrse.github.io.

vsoch avatar vsoch commented on August 29, 2024

I'll work on this after #102 is properly reviewed.

from usrse.github.io.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.